Update project_run docstring

The docstring indicated that normal use of the function called DVC to
determine if the function should be re-run, but that is not the case.
This commit is contained in:
Paul O'Leary McCann 2022-09-12 17:47:57 +09:00
parent e75c3f56c6
commit b5a0518b06

View File

@ -53,10 +53,9 @@ def project_run(
dry: bool = False,
capture: bool = False,
) -> None:
"""Run a named script defined in the project.yml. If the script is part
of the default pipeline (defined in the "run" section), DVC is used to
execute the command, so it can determine whether to rerun it. It then
calls into "exec" to execute it.
"""Run a named script defined in the project.yml. If the script is a
command rather than a workflow, it is checked against the project lock file
to see if it should be re-run.
project_dir (Path): Path to project directory.
subcommand (str): Name of command to run.