Workflow config doc refinements #4475
Conversation
| with Conf('job', desc=''' | ||
| with Conf('job', desc=dedent(''' | ||
| This section configures the means by which cylc submits task | ||
| job scripts to run. | ||
|
|
||
| ''' + DEPRECATION_WARN): | ||
| ''') + DEPRECATION_WARN): |
| command or script, or inlined scripting. | ||
| ''' + SCRIPT_COMMON) |
There was a problem hiding this comment.
Some of these had empty examples
There was a problem hiding this comment.
Sure. I'm currently working on a much bigger PR with lots of changes to workflow.py so it'd be nice to get this in quickly to avoid a horrid rebase.
Alternatively, if you wanted to make it a PR to the branch ref'd in #4475 I'd be happy to just merge it then get the second review with that PR (The review of which will be horrific, because there are so many matters of taste involved.)
Happy for either, I am currently clearing my review backlog after auth kept me so busy. I should be able to get to this one this afternoon. |
There was a problem hiding this comment.
I have build the docs and it is all templating nicely.
Thanks @MetRonnie
* 'config.fix' of github.com:wxtim/cylc: (71 commits) Apply suggestions from code review Tweak TUI job prep state icon. Reduce test flakiness on MacOS Fix logging of task state transistion to "preparing". Fix datastore job "preparing" state. Fix TUI job "preparing" state. Fix spelling error. Func test fix. Style fix. Workflow config doc refinements (cylc#4475) Update cylc/flow/cfgspec/workflow.py Fix two func tests, and a typo. Remove CYLC_WORKFLOW_DEF_PATH Address review feedback (tweak some docstrings). Update cylc/flow/task_pool.py Post rebase fix. Set flow counter from DB. Fix a func test post rebase. Fix cylc poll CLI doc. Add nosec comment. ...
This is a small change with no associated Issue.
Requirements check-list
CONTRIBUTING.mdand added my name as a Code Contributor.setup.pyandconda-environment.yml.