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

docs(options): fix some typos and improve consistency #12191

Merged

Conversation

mkniewallner
Copy link
Contributor

@mkniewallner mkniewallner commented Jul 4, 2024

Summary

Fixes a few typos and consistency issues in the "Settings" documentation:

  • use "Ruff" consistently in the few places where "ruff" is used
  • use double quotes in the few places where single quotes are used
  • add backticks around rule codes where they are currently missing
  • update a few example values where they are the same as the defaults, for consistency

2nd commit might be controversial, as there are many options mentioned where we don't currently link to the documentation sections, so maybe it's done on purpose, as this will also appear in the JSON schema where it's not desirable? If that's the case, I can easily drop it.

Test Plan

Local testing.

@mkniewallner mkniewallner marked this pull request as ready for review July 4, 2024 22:38
Copy link
Member

@charliermarsh charliermarsh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wow, this is excellent -- thank you! I skimmed through all the changes. How did you find these?

@charliermarsh charliermarsh added the documentation Improvements or additions to documentation label Jul 4, 2024
@charliermarsh
Copy link
Member

2nd commit might be controversial, as there are many options mentioned where we don't currently link to the documentation sections, so maybe it's done on purpose, as this will also appear in the JSON schema where it's not desirable? If that's the case, I can easily drop it.

I think this is true (that it will appear in the JSON Schema). But I think it's worth it.

@charliermarsh charliermarsh merged commit d12570e into astral-sh:main Jul 4, 2024
20 checks passed
@mkniewallner mkniewallner deleted the doc/misc-options-improvements branch July 4, 2024 23:06
@mkniewallner
Copy link
Contributor Author

Wow, this is excellent -- thank you! I skimmed through all the changes. How did you find these?

By manually skimming through the documentation (yeah, for real 😄).

@charliermarsh
Copy link
Member

I'm very impressed, thanks!

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