From 42fd0ba5739250c36ad325f5ce563d69c8b37235 Mon Sep 17 00:00:00 2001 From: ferruzzi Date: Thu, 11 Jul 2024 20:37:39 -0700 Subject: [PATCH 1/2] Add some context comments to pyproject.toml --- pyproject.toml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/pyproject.toml b/pyproject.toml index 80a79f18ff0bf..cc54fb988d724 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -298,12 +298,12 @@ extend-select = [ "TRY002", # Prohibit use of `raise Exception`, use specific exceptions instead. ] ignore = [ - "D100", # TODO: Missing docstring in public module + "D100", # Unwanted; Docstring at the top of every file. "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__ + "D104", # Unwanted; Docstring at the top of every `__init__.py` file. + "D105", # Unwanted; See https://lists.apache.org/thread/8jbg1dd2lr2cfydtqbjxsd6pb6q2wkc3 + "D107", # Unwanted; Docstring in every constructor is unnecesary if the class has a docstring. "D203", "D212", # Conflicts with D213. Both can not be enabled. "D214", From d14d67ebecf2b8f62d1ff94bd6dea819f58b31eb Mon Sep 17 00:00:00 2001 From: "D. Ferruzzi" Date: Fri, 12 Jul 2024 09:49:43 -0700 Subject: [PATCH 2/2] fix typo Co-authored-by: Jed Cunningham <66968678+jedcunningham@users.noreply.github.com> --- pyproject.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index cc54fb988d724..9e8970bc408b7 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -303,7 +303,7 @@ ignore = [ "D103", # TODO: Missing docstring in public function "D104", # Unwanted; Docstring at the top of every `__init__.py` file. "D105", # Unwanted; See https://lists.apache.org/thread/8jbg1dd2lr2cfydtqbjxsd6pb6q2wkc3 - "D107", # Unwanted; Docstring in every constructor is unnecesary if the class has a docstring. + "D107", # Unwanted; Docstring in every constructor is unnecessary if the class has a docstring. "D203", "D212", # Conflicts with D213. Both can not be enabled. "D214",