From 20b3fb1c8356d32e705c0dc063dd28894f80b3cb Mon Sep 17 00:00:00 2001 From: MSAdministrator Date: Mon, 15 Aug 2022 15:23:49 -0500 Subject: [PATCH] dev(darglint): Adding ignore for optional parameters within docstrings --- .darglint | 1 + src/atomic_operator_runner/local.py | 8 ++++---- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/.darglint b/.darglint index 72ccc6c..3377ee5 100644 --- 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 index 8fd5f99..f1b635b 100644 --- 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.