added pydocstyle (#62)

.github/workflows/test-rules-engine.yml

@@ -55,4 +55,19 @@ jobs:
           python-version: ${{ matrix.python-version }}
       - name: Run tests
         run: |
-          pytest
+          pytest
+  pydocstyle:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10"]
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up environment
+        uses: "./.github/actions/setup-rules-engine"
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Run tests
+        run: |
+          pydocstyle .

rules-engine/pyproject.toml

@@ -15,6 +15,7 @@ dev = [
     "black",
     "isort",
     "mypy",
+    "pydocstyle",
     "pytest",
 ]
 
@@ -24,3 +25,6 @@ profile = "black"
 [tool.mypy]
 disallow_any_generics = true
 disallow_incomplete_defs = true
+
+[tool.pydocstyle]
+select = "D207,D208,D3,D417"

rules-engine/requirements-dev.txt

@@ -34,8 +34,12 @@ platformdirs==3.7.0
     # via black
 pluggy==1.0.0
     # via pytest
+pydocstyle==6.3.0
+    # via rules-engine (pyproject.toml)
 pytest==7.3.2
     # via rules-engine (pyproject.toml)
+snowballstemmer==2.2.0
+    # via pydocstyle
 tomli==2.0.1
     # via
     #   black

rules-engine/src/rules_engine/engine.py

@@ -164,6 +164,7 @@ def calculate_balance_point_and_ua_customizable(
 
         Args:
             bps_to_remove: a list of Billing Periods that user wishes to remove from calculation
+            balance_point_sensitivity: the amount to adjust when refining the balance point
         """
 
         customized_bills = [bp for bp in self.bills if bp not in bps_to_remove]