Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix typo in option name: output_format -> output-format #9874

Merged
merged 2 commits into from
Feb 7, 2024

Conversation

hugovk
Copy link
Contributor

@hugovk hugovk commented Feb 7, 2024

Summary

Go to https://docs.astral.sh/ruff/settings/#show-source

Read deprecation notice:

This option has been deprecated. show_source is deprecated and is now part of output_format in the form of full or concise options. Please update your configuration.

Copy and paste show_source into search box.

No results.

Run Ruff and see the similar warning:

warning: The show-source option has been deprecated in favor of output-format's "full" and "concise" variants. Please update your configuration to use output-format = <full|concise> instead.

Test Plan

Copy and paste show-source into search box.

Get results, including https://docs.astral.sh/ruff/settings/#output-format.

No results.

Also

It would be great if you can link from output-format at https://docs.astral.sh/ruff/settings/#show-source to https://docs.astral.sh/ruff/settings/#output-format

It would also be nice if there was advice -- tell me how the old show-source values should be mapped to the new output-format options.

@hugovk hugovk changed the title Fix typo in option name: output_format -> -format Fix typo in option name: output_format -> output-format Feb 7, 2024
Copy link
Contributor

github-actions bot commented Feb 7, 2024

ruff-ecosystem results

Linter (stable)

✅ ecosystem check detected no linter changes.

Linter (preview)

✅ ecosystem check detected no linter changes.

@zanieb zanieb added the documentation Improvements or additions to documentation label Feb 7, 2024
@zanieb
Copy link
Member

zanieb commented Feb 7, 2024

Thank you! I totally agree "Please update your configuration" should be more specific. I don't think we have a great way to provide links yet since our documentation is not versioned we cannot ensure the links work permanently.

You can see https://astral.sh/blog/ruff-v0.2.0#output-format for more context on the deprecation.

@zanieb zanieb enabled auto-merge (squash) February 7, 2024 16:13
@zanieb zanieb merged commit bc023f4 into astral-sh:main Feb 7, 2024
16 checks passed
@hugovk hugovk deleted the fix-typo branch February 7, 2024 16:18
@hugovk
Copy link
Contributor Author

hugovk commented Feb 7, 2024

Thanks for the link, could be helpful to link to that from the docs too.

nkxxll pushed a commit to nkxxll/ruff that referenced this pull request Mar 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants