chore: Replace darglint with Ruff's implementation of pydoclint

meltano · Aug 5, 2024 · 826de72 · 826de72
1 parent 278fde4
commit 826de72
Show file tree

Hide file tree

Showing 5 changed files with 5 additions and 34 deletions.
diff --git a/.flake8 b/.flake8
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -64,18 +64,6 @@ repos:
         cookiecutter/.*
       )$
 
-- repo: https://github.com/pycqa/flake8
-  rev: 7.1.1
-  hooks:
-  - id: flake8
-    additional_dependencies:
-    - darglint==1.8.1
-    files: |
-        (?x)^(
-          singer_sdk/.*|
-          samples/.*
-        )$
-
 - repo: https://github.com/python-poetry/poetry
   rev: 1.8.0
   hooks:

diff --git a/pyproject.toml b/pyproject.toml
@@ -314,6 +314,7 @@ select = [
     "E",    # pycodestyle (error)
     "W",    # pycodestyle (warning)
     "C90",  # mccabe
+    "DOC",  # pydocstyle
     "I",    # isort
     "N",    # pep8-naming
     "D",    # pydocstyle/flake8-docstrings
@@ -373,6 +374,7 @@ unfixable = [
     "ANN",
     "D1",
     "D2",
+    "DOC",
     "FBT001",
     "FBT003",
     "PLR2004",
@@ -381,8 +383,10 @@ unfixable = [
     "PLC2701",  # Allow usage of private members in tests
     "PLR6301",  # Don't suggest making test methods static, etc.
 ]
+# Disabled some checks in helper modules
+"singer_sdk/helpers/_*.py" = ["DOC"]
 # Disabled some checks in samples code
-"samples/*" = ["ANN", "D"]
+"samples/*" = ["ANN", "D", "DOC"]
 # Templates support a generic resource of type Any.
 "singer_sdk/testing/*.py" = ["S101"]
 "singer_sdk/testing/templates.py" = ["ANN401"]

diff --git a/singer_sdk/pagination.py b/singer_sdk/pagination.py
@@ -135,10 +135,6 @@ def get_next(self, response: Response) -> TPageToken | None:
 
         Args:
             response: API response object.
-
-        Returns:
-            The next page token or index. Return `None` from this method to indicate
-                the end of pagination.
         """
         ...
 
@@ -160,10 +156,6 @@ def get_next(self, response: Response) -> None:  # noqa: ARG002, PLR6301
 
         Args:
             response: API response object.
-
-        Returns:
-            The next page token or index. Return `None` from this method to indicate
-                the end of pagination.
         """
         return
 

diff --git a/singer_sdk/streams/core.py b/singer_sdk/streams/core.py
@@ -358,9 +358,6 @@ def _write_replication_key_signpost(
         Args:
             context: Stream partition or context dictionary.
             value: TODO
-
-        Returns:
-            TODO
         """
         if not value:
             return