Skip to content

docs: fix parameter name mismatches in docstrings#11060

Open
eeshsaxena wants to merge 1 commit into
treeverse:mainfrom
eeshsaxena:fix-docstring-param-names
Open

docs: fix parameter name mismatches in docstrings#11060
eeshsaxena wants to merge 1 commit into
treeverse:mainfrom
eeshsaxena:fix-docstring-param-names

Conversation

@eeshsaxena

Copy link
Copy Markdown

Fixes two docstrings where the documented parameter names don't match the actual function signatures:

File Function Docstring said Signature has
dvc/repo/experiments/queue/base.py BaseStashQueue.__init__ scm repo
dvc/repo/experiments/queue/tasks.py cleanup_exp tmp_dir, entry_dict (stale) executor, infofile

Doc-only change; no behavior modified.

- 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
@github-project-automation github-project-automation Bot moved this to Backlog in DVC Jul 3, 2026
@CLAassistant

CLAassistant commented Jul 3, 2026

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@codecov

codecov Bot commented Jul 3, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.98%. Comparing base (2431ec6) to head (b4bb541).
⚠️ Report is 205 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #11060      +/-   ##
==========================================
+ Coverage   90.68%   90.98%   +0.29%     
==========================================
  Files         504      505       +1     
  Lines       39795    41138    +1343     
  Branches     3141     3263     +122     
==========================================
+ Hits        36087    37428    +1341     
- Misses       3042     3071      +29     
+ Partials      666      639      -27     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants