docformatter

.github/workflows/build.yml

@@ -25,6 +25,8 @@ jobs:
         run: isort --check .
       - name: Lint with black
         run: black --check .
+      - name: Lint with docformatter
+        run: docformatter --black -c **/*.py
       - name: Lint with flake8
         run: flake8
       - name: Lint with mypy

.pre-commit-config.yaml

@@ -23,6 +23,11 @@ repos:
     entry: isort
     language: system
     types: [python]
+  - id: docformatter
+    name: docformatter
+    entry: docformatter --black -i
+    language: system
+    types: [python]
   - id: pytest
     name: pytest
     entry: coverage run -m pytest --typeguard-packages=strictly_typed_pandas,tests

requirements-dev.txt

@@ -2,6 +2,7 @@ mypy==1.6.1
 flake8==6.1.0
 black[jupyter]==23.10.0
 isort==5.12.0
+docformatter==1.7.5
 coverage==7.3.2
 pytest==7.4.2
 nbconvert==7.9.2

strictly_typed_pandas/dataset.py

@@ -22,8 +22,9 @@
 
 class DataSetBase(pd.DataFrame, ABC):
     def __init__(self, *args, **kwargs) -> None:
-        """
-        This class is a subclass of `pd.DataFrame`, hence it is initialized with the same parameters as a `DataFrame`.
+        """This class is a subclass of `pd.DataFrame`, hence it is initialized with the
+        same parameters as a `DataFrame`.
+
         See the Pandas `DataFrame` documentation for more information.
         """
         super().__init__(*args, **kwargs)
@@ -75,15 +76,11 @@ def _continue_initialization(self) -> None:
         pass  # pragma: no cover
 
     def to_dataframe(self) -> pd.DataFrame:
-        """
-        Converts the object to a pandas `DataFrame`.
-        """
+        """Converts the object to a pandas `DataFrame`."""
         return pd.DataFrame(self)
 
     def to_frame(self) -> pd.DataFrame:
-        """
-        Synonym of to to_dataframe(): converts the object to a pandas `DataFrame`.
-        """
+        """Synonym of to to_dataframe(): converts the object to a pandas `DataFrame`."""
         return self.to_dataframe()
 
 
@@ -92,8 +89,7 @@ def to_frame(self) -> pd.DataFrame:
 
 
 class DataSet(Generic[T], DataSetBase):
-    """
-    `DataSet` allows for static type checking of pandas DataFrames, for example:
+    """`DataSet` allows for static type checking of pandas DataFrames, for example:
 
     .. code-block:: python
 
@@ -124,8 +120,8 @@ def _continue_initialization(self) -> None:
 
 
 class IndexedDataSet(Generic[T, V], DataSetBase):
-    """
-    `IndexedDataSet` allows for static type checking of indexed pandas DataFrames, for example:
+    """`IndexedDataSet` allows for static type checking of indexed pandas DataFrames,
+    for example:
 
     .. code-block:: text