mirror of
https://github.com/Stone-Red-Code/dvc.git
synced 2026-11-01 23:08:43 +01:00
docs: fix parameter name mismatches in docstrings (#11060)
- repo/experiments/queue/base.py: `scm` -> `repo` in BaseStashQueue.__init__ (signature takes a Repo, not an SCM instance) - repo/experiments/queue/tasks.py: stale `tmp_dir`/`entry_dict` args in cleanup_exp replaced with the actual `executor`/`infofile` parameters
This commit is contained in:
@@ -90,7 +90,7 @@ class BaseStashQueue(ABC):
|
||||
"""Construct a queue.
|
||||
|
||||
Arguments:
|
||||
scm: Git SCM instance for this queue.
|
||||
repo: DVC repo instance for this queue.
|
||||
ref: Git stash ref for this queue.
|
||||
failed_ref: Failed run Git stash ref for this queue.
|
||||
"""
|
||||
|
||||
@@ -84,8 +84,8 @@ def cleanup_exp(executor: TempDirExecutor, infofile: str) -> None:
|
||||
"""Cleanup after an experiment.
|
||||
|
||||
Arguments:
|
||||
tmp_dir: Temp directory to be removed.
|
||||
entry_dict: Serialized QueueEntry for this experiment.
|
||||
executor: Executor to clean up.
|
||||
infofile: Path to the executor info file.
|
||||
"""
|
||||
executor.cleanup(infofile)
|
||||
|
||||
|
||||
Reference in New Issue
Block a user