Improve discoverability of the pydocstyle
rules as per the selected convention
#15217
Labels
documentation
Improvements or additions to documentation
help wanted
Contributions especially welcome
If a user has
D
in the rule selection, the rules that are actually selected depends on the docstring convention that's chosen. Currently, this information only lives at the bottom of this FAQ section: https://docs.astral.sh/ruff/faq/#does-ruff-support-numpy-or-google-style-docstrings. It would be useful to have this visible in an obvious place for which I see two options:ruff.lint.pydocstyle.convention
sectionDxxx
rule page, specify how setting thelint.pydocstyle.convention
may affect the selection of this ruleI think I'd prefer option (1) as the documentation is in a single place instead of distributed across multiple rule pages.
The text was updated successfully, but these errors were encountered: