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

Docs.review spec docs #4473

Merged
merged 42 commits into from
Nov 8, 2021
Merged

Docs.review spec docs #4473

merged 42 commits into from
Nov 8, 2021

Conversation

wxtim
Copy link
Member

@wxtim wxtim commented Oct 20, 2021 •
edited by oliver-sanders
Loading

Overhaul of the config files, including responses to #4342

  • Pass through workflow.py and globalconfig.py fixing:
    • ..versionchanged & ..versionadded
    • Adding headlines to most config items.
    • Attempt to simplify language:
  • Update documentation for reset_bad_hosts mainloop plugin and added it to the list of built-in mainloop plugins.
  • Checked the Schema against the CLI.

[When finished] These changes close #4342 & #4091

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.py and
    conda-environment.yml.
  • Does not need tests (largely a documentation change).
  • No change log entry required (largely a documentation change).
  • (master branch) I have opened a documentation PR at Companion.to.cylc.reviw cylc-doc#309 - to provide an additonal :ref: anchor.

@wxtim wxtim self-assigned this Oct 20, 2021
@wxtim wxtim marked this pull request as draft October 20, 2021 07:38
@wxtim wxtim added the doc Documentation label Oct 20, 2021
@wxtim wxtim mentioned this pull request Oct 26, 2021
Merged
@wxtim wxtim marked this pull request as ready for review October 26, 2021 11:00
@wxtim
Merge branch 'master' of https://github.com/cylc/cylc into docs.revie…
406769f 
…w-spec-docs

* 'master' of https://github.com/cylc/cylc: (27 commits)
  Func test fix.
  Style fix.
  Update cylc/flow/cfgspec/workflow.py
  hopefully fixed a test
  and another test
  test. fix
  fix test. again
  another test where UTC mode=default broke
  fix test
  test - k/xtriggers/00
  fix k/special/0[58]-
  test: fix k/special/06
  test: fix k/special/04
  fix broken test
  fix unit testing
  update CHANGES.md
  add functional test for timezone -setting
  Cylc 8 timezone defaults to UTC
  test - k/xtriggers/00
  fix k/special/0[58]-
  ...
@wxtim
remove mistake
d1c7c7d
wxtim
wxtim commented Oct 26, 2021
View reviewed changes
cylc/flow/cfgspec/globalcfg.py Outdated Show resolved Hide resolved
wxtim
wxtim commented Oct 26, 2021
View reviewed changes
cylc/flow/cfgspec/globalcfg.py Outdated Show resolved Hide resolved
@wxtim wxtim requested review from oliver-sanders and datamel and removed request for oliver-sanders November 2, 2021 13:51
MetRonnie
MetRonnie reviewed Nov 2, 2021
View reviewed changes
cylc/flow/cfgspec/workflow.py Outdated Show resolved Hide resolved
cylc/flow/cfgspec/workflow.py Outdated Show resolved Hide resolved
cylc/flow/cfgspec/workflow.py Outdated Show resolved Hide resolved
cylc/flow/cfgspec/workflow.py Outdated Show resolved Hide resolved
cylc/flow/cfgspec/workflow.py Outdated Show resolved Hide resolved
cylc/flow/cfgspec/workflow.py Outdated Show resolved Hide resolved
cylc/flow/cfgspec/workflow.py Outdated Show resolved Hide resolved
cylc/flow/cfgspec/workflow.py Outdated Show resolved Hide resolved
cylc/flow/cfgspec/workflow.py Outdated Show resolved Hide resolved
cylc/flow/cfgspec/workflow.py Outdated Show resolved Hide resolved
wxtim
wxtim commented Nov 3, 2021
View reviewed changes
cylc/flow/cfgspec/globalcfg.py Outdated Show resolved Hide resolved
wxtim
wxtim commented Nov 3, 2021
View reviewed changes
cylc/flow/cfgspec/globalcfg.py Outdated Show resolved Hide resolved
wxtim
wxtim commented Nov 3, 2021
View reviewed changes
cylc/flow/cfgspec/globalcfg.py Outdated Show resolved Hide resolved
wxtim
wxtim commented Nov 3, 2021
View reviewed changes
cylc/flow/cfgspec/globalcfg.py Outdated Show resolved Hide resolved
@wxtim @MetRonnie
Apply suggestions from code review
ff317c2 
Co-authored-by: Ronnie Dutta <61982285+MetRonnie@users.noreply.github.com>
@wxtim wxtim requested a review from MetRonnie November 3, 2021 08:17
MetRonnie
MetRonnie reviewed Nov 3, 2021
View reviewed changes
cylc/flow/cfgspec/workflow.py Outdated Show resolved Hide resolved
cylc/flow/cfgspec/workflow.py Outdated Show resolved Hide resolved
cylc/flow/cfgspec/workflow.py Outdated Show resolved Hide resolved
cylc/flow/network/schema.py Outdated Show resolved Hide resolved
cylc/flow/network/schema.py Outdated Show resolved Hide resolved
cylc/flow/network/schema.py Outdated Show resolved Hide resolved
cylc/flow/scripts/broadcast.py Outdated Show resolved Hide resolved
cylc/flow/scripts/ext_trigger.py Outdated Show resolved Hide resolved
cylc/flow/scripts/hold.py Outdated Show resolved Hide resolved
cylc/flow/scripts/release.py Outdated Show resolved Hide resolved
wxtim and others added 2 commits November 4, 2021 10:43
@wxtim @MetRonnie
Update cylc/flow/cfgspec/workflow.py
064f397 
Co-authored-by: Ronnie Dutta <61982285+MetRonnie@users.noreply.github.com>
@wxtim
Update cylc/flow/cfgspec/workflow.py
f040347
wxtim
wxtim commented Nov 4, 2021
View reviewed changes
cylc/flow/network/schema.py Outdated Show resolved Hide resolved
wxtim
wxtim commented Nov 4, 2021
View reviewed changes
cylc/flow/network/schema.py Outdated Show resolved Hide resolved
@wxtim @MetRonnie
Apply suggestions from code review
ade8d78 
Co-authored-by: Ronnie Dutta <61982285+MetRonnie@users.noreply.github.com>
@wxtim wxtim requested a review from MetRonnie November 4, 2021 10:55
MetRonnie
MetRonnie approved these changes Nov 5, 2021
View reviewed changes
Copy link
Member

@MetRonnie MetRonnie left a comment

Choose a reason for hiding this comment

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

Thanks! 🚀

datamel
datamel approved these changes Nov 8, 2021
View reviewed changes
Copy link
Contributor

@datamel datamel left a comment

Choose a reason for hiding this comment

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

Great thanks, I have checked the lastest changes and will merge.
Thanks @wxtim!

@datamel datamel merged commit f603f1a into cylc:master Nov 8, 2021
@MetRonnie MetRonnie added this to the cylc-8.0b3 milestone Nov 8, 2021
This was referenced Nov 8, 2021
Merged
Closed
@wxtim wxtim deleted the docs.review-spec-docs branch March 22, 2022 17:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@hjoliver hjoliver hjoliver left review comments

@oliver-sanders oliver-sanders oliver-sanders left review comments

@datamel datamel datamel approved these changes

@MetRonnie MetRonnie MetRonnie approved these changes

Assignees

@wxtim wxtim

Labels
doc Documentation
Projects
None yet
Milestone
cylc-8.0b3
Development

Successfully merging this pull request may close these issues.

Add "changed in version x.y.z" notes to config descriptions
5 participants
@wxtim @oliver-sanders @hjoliver @datamel @MetRonnie