mirror of
https://github.com/astral-sh/ruff.git
synced 2025-10-03 15:15:33 +00:00
docs: Formatter compatibility warning for D207 and D300 (#10007)
- Update docs to mention formatter compatibility interactions for under-indentation (D207) and triple-single-quotes (D300) - Changes verified locally with mkdocs - Closes: https://github.com/astral-sh/ruff/issues/9675
This commit is contained in:
parent
20217e9bbd
commit
d46c5d8ac8
2 changed files with 11 additions and 0 deletions
|
@ -87,12 +87,17 @@ impl Violation for IndentWithSpaces {
|
||||||
/// """
|
/// """
|
||||||
/// ```
|
/// ```
|
||||||
///
|
///
|
||||||
|
/// ## Formatter compatibility
|
||||||
|
/// We recommend against using this rule alongside the [formatter]. The
|
||||||
|
/// formatter enforces consistent indentation, making the rule redundant.
|
||||||
|
///
|
||||||
/// ## References
|
/// ## References
|
||||||
/// - [PEP 257 – Docstring Conventions](https://peps.python.org/pep-0257/)
|
/// - [PEP 257 – Docstring Conventions](https://peps.python.org/pep-0257/)
|
||||||
/// - [NumPy Style Guide](https://numpydoc.readthedocs.io/en/latest/format.html)
|
/// - [NumPy Style Guide](https://numpydoc.readthedocs.io/en/latest/format.html)
|
||||||
/// - [Google Python Style Guide - Docstrings](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings)
|
/// - [Google Python Style Guide - Docstrings](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings)
|
||||||
///
|
///
|
||||||
/// [PEP 257]: https://peps.python.org/pep-0257/
|
/// [PEP 257]: https://peps.python.org/pep-0257/
|
||||||
|
/// [formatter]: https://docs.astral.sh/ruff/formatter/
|
||||||
#[violation]
|
#[violation]
|
||||||
pub struct UnderIndentation;
|
pub struct UnderIndentation;
|
||||||
|
|
||||||
|
|
|
@ -27,10 +27,16 @@ use crate::docstrings::Docstring;
|
||||||
/// """Return the pathname of the KOS root directory."""
|
/// """Return the pathname of the KOS root directory."""
|
||||||
/// ```
|
/// ```
|
||||||
///
|
///
|
||||||
|
/// ## Formatter compatibility
|
||||||
|
/// We recommend against using this rule alongside the [formatter]. The
|
||||||
|
/// formatter enforces consistent quotes, making the rule redundant.
|
||||||
|
///
|
||||||
/// ## References
|
/// ## References
|
||||||
/// - [PEP 257 – Docstring Conventions](https://peps.python.org/pep-0257/)
|
/// - [PEP 257 – Docstring Conventions](https://peps.python.org/pep-0257/)
|
||||||
/// - [NumPy Style Guide](https://numpydoc.readthedocs.io/en/latest/format.html)
|
/// - [NumPy Style Guide](https://numpydoc.readthedocs.io/en/latest/format.html)
|
||||||
/// - [Google Python Style Guide - Docstrings](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings)
|
/// - [Google Python Style Guide - Docstrings](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings)
|
||||||
|
///
|
||||||
|
/// [formatter]: https://docs.astral.sh/ruff/formatter/
|
||||||
#[violation]
|
#[violation]
|
||||||
pub struct TripleSingleQuotes {
|
pub struct TripleSingleQuotes {
|
||||||
expected_quote: Quote,
|
expected_quote: Quote,
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue