Skip to content

Update the userguide CLI docs to mention resuming#1878

Open
IAlibay wants to merge 32 commits intomainfrom
resume_cli_ug
Open

Update the userguide CLI docs to mention resuming#1878
IAlibay wants to merge 32 commits intomainfrom
resume_cli_ug

Conversation

@IAlibay
Copy link
Member

@IAlibay IAlibay commented Mar 19, 2026

Fixes #1877

Checklist

  • All new code is appropriately documented (user-facing code must have complete docstrings).
  • Added a news entry, or the changes are not user-facing.
  • Ran pre-commit: you can run pre-commit locally or comment on this PR with pre-commit.ci autofix.

Manual Tests: these are slow so don't need to be run every commit, only before merging and when relevant changes are made (generally at reviewer-discretion).

Developers certificate of origin

@codecov
Copy link

codecov bot commented Mar 19, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 91.21%. Comparing base (d69baa6) to head (99ae399).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1878      +/-   ##
==========================================
- Coverage   94.79%   91.21%   -3.58%     
==========================================
  Files         205      206       +1     
  Lines       17957    18318     +361     
==========================================
- Hits        17022    16709     -313     
- Misses        935     1609     +674     
Flag Coverage Δ
fast-tests 91.21% <100.00%> (?)
slow-tests ?

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 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.

@IAlibay IAlibay marked this pull request as ready for review March 19, 2026 13:52
@IAlibay IAlibay changed the title [WIP] Update the userguide CLI docs to mention resuming Update the userguide CLI docs to mention resuming Mar 19, 2026
@IAlibay
Copy link
Member Author

IAlibay commented Mar 19, 2026

Targetting main because I don't want to block #1848 but can retarget as necessary.

@IAlibay IAlibay requested a review from atravitz March 19, 2026 13:56
@atravitz atravitz added this to the 1.10.0 milestone Mar 19, 2026
@atravitz atravitz self-assigned this Mar 20, 2026
Copy link
Contributor

@atravitz atravitz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a couple suggestions, and I'll revisit this once more once naming is finalized.

Comment on lines +69 to +72

Recovery failed, please remove <work-dir>/quickrun_cache/<transformation_key>-protocolDAG.json
and any results from your working directory before continuing to create a new protocol, or run without `--resume`.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Recovery failed, please remove <work-dir>/quickrun_cache/<transformation_key>-protocolDAG.json
and any results from your working directory before continuing to create a new protocol, or run without `--resume`.
Recovery failed, please remove <work-dir>/quickrun_cache/<transformation_key>-protocolDAG.json
and any results from your working directory before continuing to create a new protocol.

updating to reflect the changed behavior.

IAlibay and others added 6 commits March 23, 2026 10:38
Co-authored-by: Alyssa Travitz <31974495+atravitz@users.noreply.github.com>
Co-authored-by: Alyssa Travitz <31974495+atravitz@users.noreply.github.com>
@github-actions
Copy link

No API break detected ✅

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.

Update userguide CLI docs to mention resuming

2 participants