dev(darglint): Adding ignore for optional parameters within docstrings

swimlane · Aug 15, 2022 · 20b3fb1 · 20b3fb1
1 parent 28645c7
commit 20b3fb1
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 4 deletions.
diff --git a/.darglint b/.darglint
@@ -1,2 +1,3 @@
 [darglint]
 strictness = long
+ignore=DAR103
diff --git a/src/atomic_operator_runner/local.py b/src/atomic_operator_runner/local.py
@@ -18,10 +18,10 @@ def run(
         Args:
             executor (str): The executor to use when executing the provided command string.
             command (str): The command string to run.
-            timeout (int): Timeout when running a command. Defaults to 5.
-            shell (bool): Whether to spawn a new shell or not. Defaults to False.
-            env (dict): Environment to use including environmental variables.. Defaults to os.environ.
-            cwd (str): The current working directory. Defaults to None.
+            timeout (int, optional): Timeout when running a command. Defaults to 5.
+            shell (bool, optional): Whether to spawn a new shell or not. Defaults to False.
+            env (dict, optional): Environment to use including environmental variables.. Defaults to os.environ.
+            cwd (str, optional): The current working directory. Defaults to None.
 
         Returns:
             Dict[str]: Returns a dictionary of results from running the provided command.