mirrors/ruff
1
0
Fork 0
mirror of https://github.com/astral-sh/ruff.git synced 2025-08-04 10:48:32 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Ignore blank line rules for docs formatting (#12934)

Browse source 
## Summary

fixes: #12933 

## Test Plan

`python scripts/check_docs_formatted.py --generate-docs`
This commit is contained in:
Dhruv Manilawala 2024-08-16 20:57:36 +05:30 • committed by GitHub
parent ef1f6d98a0
commit c319414e54
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 4 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

2
crates/ruff_linter/src/rules/pydocstyle/rules/blank_before_after_class.rs
View file

@ -34,6 +34,7 @@ use crate::registry::Rule;
/// ///
/// ```python /// ```python
/// class PhotoMetadata: /// class PhotoMetadata:
///
/// """Metadata about a photo.""" /// """Metadata about a photo."""
/// ``` /// ```
/// ///
@ -125,6 +126,7 @@ impl AlwaysFixableViolation for OneBlankLineAfterClass {
/// ///
/// ```python /// ```python
/// class PhotoMetadata: /// class PhotoMetadata:
///
/// """Metadata about a photo.""" /// """Metadata about a photo."""
/// ``` /// ```
/// ///

2
scripts/check_docs_formatted.py
View file

@ -34,6 +34,7 @@ KNOWN_FORMATTING_VIOLATIONS = [
"bad-quotes-inline-string", "bad-quotes-inline-string",
"bad-quotes-multiline-string", "bad-quotes-multiline-string",
"blank-line-after-decorator", "blank-line-after-decorator",
"blank-line-before-class",
"blank-line-between-methods", "blank-line-between-methods",
"blank-lines-after-function-or-class", "blank-lines-after-function-or-class",
"blank-lines-before-nested-definition", "blank-lines-before-nested-definition",
@ -67,6 +68,7 @@ KNOWN_FORMATTING_VIOLATIONS = [
"no-space-after-inline-comment", "no-space-after-inline-comment",
"non-empty-stub-body", "non-empty-stub-body",
"one-blank-line-after-class", "one-blank-line-after-class",
"one-blank-line-before-class",
"over-indentation", "over-indentation",
"over-indented", "over-indented",
"pass-statement-stub-body", "pass-statement-stub-body",