You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Enabling a convention will force-disable any rules that are not included in the specified convention
But I can't seem to find documentation about which rules are included in which conventions! Maybe I totally missed it, but I only found this information by going to the source code and finding
Is there some place this is documented? If not, how easy/hard would it be to add some documentation? I'd be happy to contribute a patch if the best way is to just add some markdown at
/// Enabling a convention will force-disable any rules that are not
, but maybe there's some clever way to auto-generate that information from the code to ensure it stays in sync?
The text was updated successfully, but these errors were encountered:
alanhdu
changed the title
Document which pydocstyle rules are disabled by which conventions?
[pydocstyle] Document which rules are disabled by which conventions?
Nov 9, 2023
The list originally comes from pydocstyle. Perhaps we could enumerate the conventions in the FAQ, as part of the "Does Ruff support NumPy- or Google-style docstrings?" section?
On https://docs.astral.sh/ruff/settings/#pydocstyle-convention, it says
But I can't seem to find documentation about which rules are included in which conventions! Maybe I totally missed it, but I only found this information by going to the source code and finding
ruff/crates/ruff_linter/src/rules/pydocstyle/settings.rs
Line 24 in 4760af3
Is there some place this is documented? If not, how easy/hard would it be to add some documentation? I'd be happy to contribute a patch if the best way is to just add some markdown at
ruff/crates/ruff_workspace/src/options.rs
Line 2378 in 4760af3
The text was updated successfully, but these errors were encountered: