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

Refer to rules in settings documentation #16095

Open
DaniBodor opened this issue Feb 11, 2025 · 1 comment
Open

Refer to rules in settings documentation #16095

DaniBodor opened this issue Feb 11, 2025 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@DaniBodor
Copy link
Contributor

DaniBodor commented Feb 11, 2025

Not sure whether this should be part of #1773 and/or #1774, but figured it's maybe just about different enough to create a separate issue.

Currently, when looking at the settings in the documentation or when going through a ruff settings file, there is no way to know which setting the rule interacts with.
Conversely, if I want to change the settings regarding a specific rule, I will almost always need to refer to that rule's documentation page to find what the rule is called. There is no logical way to deduce it without checking the documentation, unless one happens to know. (Also, there is no safeguard that the documentation for a rule is up to date with this, so can be forgotten when updating a rule as e.g. just happened here).

It would be nice if:

  1. the settings documentation states which rule a given setting refers to
  2. there were some logical way to link settings names to rule names (this will probably not be touched before Human-friendly rule names #1773/Rule categorization #1774)
  3. some workflow ensuring that updates to rules also require updates in rule documentation
@DaniBodor DaniBodor changed the title Settings name to match rule codes Refer to rules in settings documentation Feb 11, 2025
@MichaReiser MichaReiser added the documentation Improvements or additions to documentation label Feb 11, 2025
@dhruvmanila
Copy link
Member

dhruvmanila commented Feb 12, 2025

For reference, Clippy has a "Configuration" section (example) although I haven't looked at whether it's being generated automatically or not. It would be useful to have it done automatically, not sure how though.

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

No branches or pull requests

3 participants