mirrors/ruff
1
0
Fork 0
mirror of https://github.com/astral-sh/ruff.git synced 2025-07-09 22:25:09 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Complete documentation for pydocstyle rules (#5387)

Browse source 
## Summary

Completes the documentation for the `pydocstyle` ruleset. Related to
#2646.

## Test Plan

`python scripts/check_docs_formatted.py`
This commit is contained in:
Tom Kuson 2023-06-27 19:12:21 +01:00 • committed by GitHub
parent 032b967b05
commit 035f8993f4
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
19 changed files with 1735 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

6
scripts/check_docs_formatted.py
View file

@ -33,6 +33,7 @@ KNOWN_FORMATTING_VIOLATIONS = [
"bad-quotes-inline-string",
"bad-quotes-multiline-string",
"explicit-string-concatenation",
"indent-with-spaces",
"indentation-with-invalid-multiple",
"line-too-long",
"missing-trailing-comma",
@ -44,15 +45,20 @@ KNOWN_FORMATTING_VIOLATIONS = [
"multiple-spaces-before-operator",
"multiple-statements-on-one-line-colon",
"multiple-statements-on-one-line-semicolon",
"no-blank-line-before-function",
"no-indented-block-comment",
"no-space-after-block-comment",
"no-space-after-inline-comment",
"one-blank-line-after-class",
"over-indentation",
"over-indented",
"prohibited-trailing-comma",
"shebang-leading-whitespace",
"surrounding-whitespace",
"too-few-spaces-before-inline-comment",
"trailing-comma-on-bare-tuple",
"triple-single-quotes",
"under-indentation",
"unexpected-indentation-comment",
"unicode-kind-prefix",
"unnecessary-class-parentheses",