Merge pull request #47 from ImperialCollegeLondon/fix_docstrings

Fix long lines
ImperialCollegeLondon · Jan 11, 2024 · c89535e · c89535e
2 parents bb247d6 + 624b89d
commit c89535e
Show file tree

Hide file tree

Showing 19 changed files with 855 additions and 1,069 deletions.
diff --git a/pyproject.toml b/pyproject.toml
@@ -33,7 +33,7 @@ dev = [
     "black",
     "ruff",
     "pip-tools",
-    "pytest-cov",
+    "pytest-cov"
 ]
 
 demos = [
@@ -62,8 +62,5 @@ addopts = "-v -p no:warnings --cov=wsimod --cov-report=html"
 select = ["E", "F", "I"] # pycodestyle, Pyflakes, isort. Ignoring pydocstyle (D), for now
 exclude = ["docs", "tests"]  # Let's ignore tests and docs folders, for now
 
-[tool.ruff.per-file-ignores]
-"wsimod/*" = ["E501"]  # 176 lines (all comments) are too long (>88). Ignoring, for now
-
 [tool.ruff.pydocstyle]
 convention = "google"
diff --git a/requirements-dev.txt b/requirements-dev.txt
@@ -14,12 +14,6 @@ click==8.1.7
     # via
     #   black
     #   pip-tools
-colorama==0.4.6
-    # via
-    #   build
-    #   click
-    #   pytest
-    #   tqdm
 coverage[toml]==7.3.2
     # via pytest-cov
 dill==0.3.7

diff --git a/requirements.txt b/requirements.txt
@@ -2,10 +2,8 @@
 # This file is autogenerated by pip-compile with Python 3.11
 # by the following command:
 #
-#    pip-compile --output-file=requirements.txt
+#    pip-compile
 #
-colorama==0.4.6
-    # via tqdm
 dill==0.3.7
     # via wsimod (pyproject.toml)
 numpy==1.26.2

diff --git a/wsimod/arcs/arcs.py b/wsimod/arcs/arcs.py
diff --git a/wsimod/core/constants.py b/wsimod/core/constants.py
@@ -2,14 +2,14 @@
 """Created on Fri Dec  6 15:17:07 2019.
 
 @author: bdobson
-
 """
 from wsimod.core import constants
 
 M3_S_TO_ML_D = 86.4
 MM_KM2_TO_ML = 1e-3 * 1e6 * 1e3 * 1e-6  # mm->m, km2->m2, m3->l, l->Ml
 MM_M2_TO_ML = 1e-3 * 1e3 * 1e-6  # mm->m, m3->l, l->Ml
-MM_M2_TO_SIM_VOLUME = MM_M2_TO_ML  # SIM volume is by default ML, but can be changed by changing MM_TO_SIM_VOLUME
+MM_M2_TO_SIM_VOLUME = MM_M2_TO_ML  # SIM volume is by default ML, but can be changed by
+# changing MM_TO_SIM_VOLUME
 MM_M2_TO_M3 = 1e-3  # mm->m
 ML_TO_M3 = 1000
 PCT_TO_PROP = 1 / 100
@@ -117,7 +117,8 @@ def set_default_pollutants():
         "do",
         "temperature",
         "ph",
-    ]  # e.g. pollutants whose concentration should not increase if volume is distilled out
+    ]  # e.g. pollutants whose concentration should not increase if volume is distilled
+    # out
     constants.ADDITIVE_POLLUTANTS = [
         "org-phosphorus",
         "phosphate",