language-servers/ruff
1
0
Fork 0
mirror of https://github.com/astral-sh/ruff.git synced 2025-10-03 23:25:14 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

pydocstyle: Add ignore setting to linter docs (#12996)

Browse source
This commit is contained in:
Alex Lowe 2024-08-20 02:33:50 -04:00 • committed by GitHub
parent fc811f5168
commit abb4cdbf3d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 12 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

12
crates/ruff_linter/src/rules/pydocstyle/rules/not_missing.rs
View file

@ -218,6 +218,9 @@ impl Violation for UndocumentedPublicClass {
/// raise ValueError("Tried to greet an unhappy cat.") /// raise ValueError("Tried to greet an unhappy cat.")
/// ``` /// ```
/// ///
/// ## Options
/// - `lint.pydocstyle.ignore-decorators`
///
/// ## References /// ## References
/// - [PEP 257 – Docstring Conventions](https://peps.python.org/pep-0257/) /// - [PEP 257 – Docstring Conventions](https://peps.python.org/pep-0257/)
/// - [PEP 287 – reStructuredText Docstring Format](https://peps.python.org/pep-0287/) /// - [PEP 287 – reStructuredText Docstring Format](https://peps.python.org/pep-0287/)
@ -305,6 +308,9 @@ impl Violation for UndocumentedPublicMethod {
/// raise FasterThanLightError from exc /// raise FasterThanLightError from exc
/// ``` /// ```
/// ///
/// ## Options
/// - `lint.pydocstyle.ignore-decorators`
///
/// ## References /// ## References
/// - [PEP 257 – Docstring Conventions](https://peps.python.org/pep-0257/) /// - [PEP 257 – Docstring Conventions](https://peps.python.org/pep-0257/)
/// - [PEP 287 – reStructuredText Docstring Format](https://peps.python.org/pep-0287/) /// - [PEP 287 – reStructuredText Docstring Format](https://peps.python.org/pep-0287/)
@ -402,6 +408,9 @@ impl Violation for UndocumentedPublicPackage {
/// print(cat) # "Cat: Dusty" /// print(cat) # "Cat: Dusty"
/// ``` /// ```
/// ///
/// ## Options
/// - `lint.pydocstyle.ignore-decorators`
///
/// ## References /// ## References
/// - [PEP 257 – Docstring Conventions](https://peps.python.org/pep-0257/) /// - [PEP 257 – Docstring Conventions](https://peps.python.org/pep-0257/)
/// - [PEP 287 – reStructuredText Docstring Format](https://peps.python.org/pep-0287/) /// - [PEP 287 – reStructuredText Docstring Format](https://peps.python.org/pep-0287/)
@ -502,6 +511,9 @@ impl Violation for UndocumentedPublicNestedClass {
/// self.population: int = population /// self.population: int = population
/// ``` /// ```
/// ///
/// ## Options
/// - `lint.pydocstyle.ignore-decorators`
///
/// ## References /// ## References
/// - [PEP 257 – Docstring Conventions](https://peps.python.org/pep-0257/) /// - [PEP 257 – Docstring Conventions](https://peps.python.org/pep-0257/)
/// - [PEP 287 – reStructuredText Docstring Format](https://peps.python.org/pep-0287/) /// - [PEP 287 – reStructuredText Docstring Format](https://peps.python.org/pep-0287/)