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

Improve config reference docs #4916

Merged
merged 8 commits into from
Jun 29, 2022
Merged

Improve config reference docs #4916

merged 8 commits into from
Jun 29, 2022

Conversation

MetRonnie
Copy link
Member

These changes close #4851

  • Ensure config items shared by global and workflow configs have links to each other
  • Centralised such items' descriptions and display the full description for the workflow item, whereas only the first paragraph for the global item
  • Tidy up these docs a bit and fix the odd mistake

Would recommend a commit-by-commit review.

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.
  • Does not need tests (just made sure docs build properly).
  • No change log entry required (just a docs change).
  • No documentation update required.

@MetRonnie MetRonnie added the doc Documentation label Jun 15, 2022
@MetRonnie MetRonnie added this to the cylc-8.0rc4 milestone Jun 15, 2022
@MetRonnie MetRonnie requested a review from wxtim June 15, 2022 14:58
@MetRonnie MetRonnie self-assigned this Jun 15, 2022
@MetRonnie MetRonnie modified the milestones: cylc-8.0rc4, cylc-8.0rc5 Jun 23, 2022
@wxtim wxtim merged commit 075852c into cylc:master Jun 29, 2022
@MetRonnie MetRonnie deleted the config-doc branch June 29, 2022 14:22
wxtim added a commit to wxtim/cylc that referenced this pull request Jul 4, 2022
* master: (30 commits)
  Log dir tidy (cylc#4836)
  Cut down on back-compat warnings, plus other tidying (cylc#4943)
  Validate platform settings (background job runner) (cylc#4938)
  clean: push error message to stderr
  Update cylc/flow/id_match.py
  Fix unintended directory stripping during cylc install (cylc#4931)
  stop cylc validate swallowing useful errors (cylc#4936)
  Improve config reference docs (cylc#4916)
  glblcfg: increase default rolling archive length
  Fix job state with pre-submitted failure
  Update tests/functional/cylc-reinstall/02-failures.t
  reinstall: require workflow ID argument
  play: upgrade --start-task's specified in legacy format (cylc#4925)
  expand schema docstring internally (cylc#4926)
  Added a new task filtering test.
  Add comment [skip ci]
  Fix optparse Options class for std options (cylc#4919)
  uid: warn if the run number is provided as a cycle
  Tweak prev.
  Fix task filtering.
  ...
@hjoliver hjoliver modified the milestones: cylc-8.0rc4, cylc-8.0.0 Jul 5, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Check Config Documentation for items over-ridden in workflow config
4 participants