Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update runahead limit documentation. #479

Merged
merged 2 commits into from
Jul 22, 2022
Merged

Conversation

hjoliver
Copy link
Member

Goes with cylc/cylc-flow#4906

Draft till I read through it myself, fix cross references, and check the build.

@hjoliver hjoliver added this to the 8.0rc4 milestone Jun 16, 2022
@hjoliver hjoliver self-assigned this Jun 16, 2022
@hjoliver hjoliver modified the milestones: 8.0rc4, 8.0.0 Jul 7, 2022
@hjoliver hjoliver marked this pull request as ready for review July 22, 2022 01:13
@hjoliver
Copy link
Member Author

This one needs to be in 8.0 (cylc/cylc-flow#4906 has been merged).

Copy link
Member

@wxtim wxtim left a comment

Choose a reason for hiding this comment

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

Trivial thoughts added. Happy enough.

src/user-guide/writing-workflows/scheduling.rst Outdated Show resolved Hide resolved

Runahead limiting does not restrict activity within a cycle point.
Copy link
Member

Choose a reason for hiding this comment

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

Is this note not worth keeping? I think it helps clarify what a runahead limit can and can't do. Especially now queues actually have a performance benefit?

Copy link
Member Author

@hjoliver hjoliver Jul 22, 2022

Choose a reason for hiding this comment

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

Yes it is - I just moved it, and highlighted it in a "note" box. See lines 2080-2084 below

Copy link
Member

Choose a reason for hiding this comment

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

Sorry - missed that.

@wxtim wxtim merged commit c0414e3 into cylc:master Jul 22, 2022
@hjoliver hjoliver deleted the runahead-doc branch July 22, 2022 10:01
wxtim added a commit to wxtim/cylc-doc that referenced this pull request Jul 29, 2022
…heck

* 'master' of github.com:cylc/cylc-doc:
  Update intersphinx mapping
  updated task-job.png (cylc#509)
  Document `cylc lint` (cylc#480)
  8.0.0 - release edits (cylc#507)
  document CYLC_WORKFLOW_NAME_BASE
  s/expected/required/g outputs. (cylc#492)
  clarify that run hosts should share a file system
  Update runahead limit documentation. (cylc#479)
  spelling corrections (cylc#500)
  Fix some shell variable names. (cylc#503)
  Document abort meaning.
  re-added summary of platforms to changes summary (cylc#487)
  Tweak new docs.
  Document how to continue a Cylc 7 run with Cylc 8.
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.

2 participants