From abb4cdbf3de68480002e2ff1f6e770a02af1578c Mon Sep 17 00:00:00 2001 From: Alex Lowe Date: Tue, 20 Aug 2024 02:33:50 -0400 Subject: [PATCH] pydocstyle: Add ignore setting to linter docs (#12996) --- .../src/rules/pydocstyle/rules/not_missing.rs | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/crates/ruff_linter/src/rules/pydocstyle/rules/not_missing.rs b/crates/ruff_linter/src/rules/pydocstyle/rules/not_missing.rs index a2b2a806f9d1e..ba8d5d14c0a4a 100644 --- a/crates/ruff_linter/src/rules/pydocstyle/rules/not_missing.rs +++ b/crates/ruff_linter/src/rules/pydocstyle/rules/not_missing.rs @@ -218,6 +218,9 @@ impl Violation for UndocumentedPublicClass { /// raise ValueError("Tried to greet an unhappy cat.") /// ``` /// +/// ## Options +/// - `lint.pydocstyle.ignore-decorators` +/// /// ## References /// - [PEP 257 – Docstring Conventions](https://peps.python.org/pep-0257/) /// - [PEP 287 – reStructuredText Docstring Format](https://peps.python.org/pep-0287/) @@ -305,6 +308,9 @@ impl Violation for UndocumentedPublicMethod { /// raise FasterThanLightError from exc /// ``` /// +/// ## Options +/// - `lint.pydocstyle.ignore-decorators` +/// /// ## References /// - [PEP 257 – Docstring Conventions](https://peps.python.org/pep-0257/) /// - [PEP 287 – reStructuredText Docstring Format](https://peps.python.org/pep-0287/) @@ -402,6 +408,9 @@ impl Violation for UndocumentedPublicPackage { /// print(cat) # "Cat: Dusty" /// ``` /// +/// ## Options +/// - `lint.pydocstyle.ignore-decorators` +/// /// ## References /// - [PEP 257 – Docstring Conventions](https://peps.python.org/pep-0257/) /// - [PEP 287 – reStructuredText Docstring Format](https://peps.python.org/pep-0287/) @@ -502,6 +511,9 @@ impl Violation for UndocumentedPublicNestedClass { /// self.population: int = population /// ``` /// +/// ## Options +/// - `lint.pydocstyle.ignore-decorators` +/// /// ## References /// - [PEP 257 – Docstring Conventions](https://peps.python.org/pep-0257/) /// - [PEP 287 – reStructuredText Docstring Format](https://peps.python.org/pep-0287/)