Skip to content

Add D1 pydocstyle rules to pyproject.toml #40569

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
potiuk merged 1 commit into from
Jul 3, 2024
Merged

Add D1 pydocstyle rules to pyproject.toml #40569

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -276,8 +276,7 @@ extend-select = [
"RUF019", # Checks for unnecessary key check
"RUF100", # Unused noqa (auto-fixable)
# We ignore more pydocstyle than we enable, so be more selective at what we enable
"D101",
"D106",
"D1",
"D2",
"D213", # Conflicts with D212. Both can not be enabled.
"D3",
Expand All @@ -299,6 +298,12 @@ extend-select = [
"TRY002", # Prohibit use of `raise Exception`, use specific exceptions instead.
]
ignore = [
"D100", # TODO: Missing docstring in public module
"D102", # TODO: Missing docstring in public method
"D103", # TODO: Missing docstring in public function
"D104", # TODO: Missing docstring in public package
"D105", # Do not want. See https://lists.apache.org/thread/8jbg1dd2lr2cfydtqbjxsd6pb6q2wkc3
"D107", # TODO: Missing docstring in __init__
"D203",
"D212", # Conflicts with D213. Both can not be enabled.
"D214",
Expand Down