From 86e0d4783bcb9ac74131678bd2dd1c4252866505 Mon Sep 17 00:00:00 2001 From: "D. Ferruzzi" Date: Wed, 3 Jul 2024 02:36:33 -0700 Subject: [PATCH] Add D1 pydocstyle rules to pyproject.toml (#40569) --- pyproject.toml | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/pyproject.toml b/pyproject.toml index 0d5609bb049eb..80a79f18ff0bf 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -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", @@ -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",