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.

Sign up for GitHub

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

Jump to bottom

Polling docs #4848

Merged
merged 10 commits into from
May 13, 2022
Merged

Polling docs #4848

merged 10 commits into from
May 13, 2022

Conversation

wxtim
Copy link
Member

@wxtim wxtim commented May 3, 2022 •
edited
Loading

This is a small change with no associated Issue.

Description of issue

We want to continue to allow users to over-ride platform settings of

  • submission retry delays
  • submission polling intervals
  • execution polling intervals

on a per-task basis. We are not planning to deprecate the task config items at Cylc 9.

Description of changes:

  • Applied @dpmatthews 's changes to the descriptions of the three config items in globalcfg.py
  • Removed deprecation warning for the items in workflow.py
  • Import @dpmatthews descriptions of the config items from globalcfg.py to workflow.py and used these in the config description there, adding only that these over-ride the setting in global.cylc..
  • Add a link to the list of built in job runners from the job runner config item.

Requirements check-list

  • I have read CONTRIBUTING.md and added my name as a Code Contributor.
  • Contains logically grouped changes (else tidy your branch by rebase).
  • Does not contain off-topic changes (use other PRs for other changes).
  • Applied any dependency changes to both setup.cfg and conda-environment.yml.
  • Testing
    • Already covered by existing tests.
    • Built and checked Cylc Doc against these changes.
  • No change log entry required: This is a documentation and config deprecation warning change.
  • No documentation update required.

@wxtim wxtim self-assigned this May 3, 2022
@wxtim wxtim requested a review from dpmatthews May 3, 2022 15:50
hjoliver
hjoliver requested changes May 4, 2022
View reviewed changes
cylc/flow/cfgspec/globalcfg.py Outdated Show resolved Hide resolved
cylc/flow/cfgspec/globalcfg.py Outdated Show resolved Hide resolved
cylc/flow/cfgspec/globalcfg.py Outdated Show resolved Hide resolved
cylc/flow/cfgspec/globalcfg.py Outdated Show resolved Hide resolved
cylc/flow/cfgspec/globalcfg.py Outdated Show resolved Hide resolved
cylc/flow/cfgspec/globalcfg.py Outdated Show resolved Hide resolved
cylc/flow/cfgspec/globalcfg.py Outdated Show resolved Hide resolved
@oliver-sanders oliver-sanders added this to the cylc-8.0rc4 milestone May 4, 2022
@wxtim wxtim mentioned this pull request May 4, 2022
Closed
2 tasks
@wxtim wxtim requested review from dpmatthews and hjoliver May 5, 2022 09:18
@wxtim
Copy link
Member Author

wxtim commented May 5, 2022

Plenty of scope for mission creep here, which I've documented in #4851

wxtim added 2 commits May 5, 2022 10:20
@wxtim
Reverted changes and warnings for config items set in platforms
49526bf 
but over-ridden by tasks:
- submission retry delays
- submission polling intervals
- execution retry delays
@wxtim
Apply suggestions from code review
29d6bec 
Co-authored-by: Hilary James Oliver <[email protected]>

- Moved descriptions into workflow config
- Removed links copying text from one config to another
- Added links to the default/override in the other config to each of the three settings
@wxtim wxtim requested a review from hjoliver May 6, 2022 10:45
@dpmatthews dpmatthews mentioned this pull request May 6, 2022
Open
@wxtim
Copy link
Member Author

wxtim commented May 11, 2022

@hjoliver - have I missed something you are waiting on for a re-review?

hjoliver
hjoliver approved these changes May 12, 2022
View reviewed changes
Copy link
Member

@hjoliver hjoliver left a comment

Choose a reason for hiding this comment

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

👍 good!

@hjoliver
Copy link
Member

hjoliver commented May 13, 2022 •
edited
Loading

(Sorry, one conflict now!)
[UPDATE] resolved it myself.

@hjoliver hjoliver merged commit 220fa20 into cylc:master May 13, 2022
@dpmatthews dpmatthews modified the milestones: cylc-8.0rc4, cylc-8.0rc3 May 13, 2022
@wxtim wxtim deleted the polling-docs branch October 10, 2022 08:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@hjoliver hjoliver hjoliver approved these changes

@dpmatthews dpmatthews dpmatthews approved these changes

Assignees

@wxtim wxtim

Labels
None yet
Projects
None yet
Milestone
cylc-8.0rc3
Development

Successfully merging this pull request may close these issues.
4 participants
@wxtim @hjoliver @dpmatthews @oliver-sanders