Add docstring checks to ruff

fiaisis · Jan 7, 2025 · f092c1f · f092c1f
1 parent a955368
commit f092c1f
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/fia_auth/roles.py b/fia_auth/roles.py
@@ -5,8 +5,8 @@
 
 
 def is_instrument_scientist(user_number: int) -> bool:
-    """
-    Checks if the user number is an instrument scientist according to UOWs (User Office Web Service)
+    """Check if the user number is an instrument scientist according to UOWs (User Office Web Service).
+
     :param user_number: The user number assigned to each user from UOWs
     :return: True if the user number is an instrument scientist, false if not or failed connection.
     """

diff --git a/pyproject.toml b/pyproject.toml
@@ -46,6 +46,7 @@ select = [
     "F",     # flake8 - Basic initial rules
     "E",     # pycodestyle (Error) - pep8 compliance
     "W",     # pycodestyle (Warning) - pep8 compliance
+    "D",     # pydocstyle - Enforce docstrings present
     "C90",   # mccabe - flags extremely complex functions
     "I",     # isort - Sort imports and flag missing imports
     "N",     # pep8-naming - Ensures pep8 compliance for naming