File tree 2 files changed +11
-0
lines changed
crates/ruff_linter/src/rules/pydocstyle/rules
2 files changed +11
-0
lines changed Original file line number Diff line number Diff line change @@ -87,12 +87,17 @@ impl Violation for IndentWithSpaces {
87
87
/// """
88
88
/// ```
89
89
///
90
+ /// ## Formatter compatibility
91
+ /// We recommend against using this rule alongside the [formatter]. The
92
+ /// formatter enforces consistent indentation, making the rule redundant.
93
+ ///
90
94
/// ## References
91
95
/// - [PEP 257 – Docstring Conventions](https://peps.python.org/pep-0257/)
92
96
/// - [NumPy Style Guide](https://numpydoc.readthedocs.io/en/latest/format.html)
93
97
/// - [Google Python Style Guide - Docstrings](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings)
94
98
///
95
99
/// [PEP 257]: https://peps.python.org/pep-0257/
100
+ /// [formatter]: https://docs.astral.sh/ruff/formatter/
96
101
#[ violation]
97
102
pub struct UnderIndentation ;
98
103
Original file line number Diff line number Diff line change @@ -27,10 +27,16 @@ use crate::docstrings::Docstring;
27
27
/// """Return the pathname of the KOS root directory."""
28
28
/// ```
29
29
///
30
+ /// ## Formatter compatibility
31
+ /// We recommend against using this rule alongside the [formatter]. The
32
+ /// formatter enforces consistent quotes, making the rule redundant.
33
+ ///
30
34
/// ## References
31
35
/// - [PEP 257 – Docstring Conventions](https://peps.python.org/pep-0257/)
32
36
/// - [NumPy Style Guide](https://numpydoc.readthedocs.io/en/latest/format.html)
33
37
/// - [Google Python Style Guide - Docstrings](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings)
38
+ ///
39
+ /// [formatter]: https://docs.astral.sh/ruff/formatter/
34
40
#[ violation]
35
41
pub struct TripleSingleQuotes {
36
42
expected_quote : Quote ,
You can’t perform that action at this time.
0 commit comments