Improve flow.cylc reference docs
#4846
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
wxtim
approved these changes
May 3, 2022
cylc/flow/cfgspec/workflow.py
Outdated
Comment on lines
179
to
180
| If ``True``, the workflow will use UTC as the time zone for | ||
| cycle points and timestamps in the logs. |
There was a problem hiding this comment.
Possible alt, take or leave.
Suggested change
| If ``True``, the workflow will use UTC as the time zone for | |
| cycle points and timestamps in the logs. | |
| If ``True``, the workflow logs will use UTC as the time zone for | |
| cycle points and timestamps. | |
| If ``False`` System time will be used. |
There was a problem hiding this comment.
Actually when I think about it, UTC mode only affects the log timestamps ever since #4457. Updated this description accordingly
cylc/flow/cfgspec/workflow.py
Outdated
|
|
||
| If instead you only want to set a time zone for cycle points, | ||
| leaving log timestamps to use the local/system time zone, | ||
| see :cylc:conf:`flow.cylc[scheduler]cycle point time zone`. |
There was a problem hiding this comment.
Suggested change
| see :cylc:conf:`flow.cylc[scheduler]cycle point time zone`. | |
| see :cylc:conf:`flow.cylc[scheduler]cycle point time zone`. | |
| (`cycle point time zone` defaults to UTC.) |
| this to ``False``. | ||
| .. admonition:: Cylc 7 compatibility mode | ||
|
|
||
| In :ref:`Cylc_7_compat_mode`, implicit tasks are still |
There was a problem hiding this comment.
Have I missed a discussion about this?
There's a slight inconsistency in that I thought that we were going to allow implicit tasks in compatibility mode, unless a rose-suite.conf is present (since Rose 2019 had behaviour equivalent to implicit tasks = False).
There was a problem hiding this comment.
Good point, that was never updated in the docs
hjoliver
approved these changes
May 3, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a small change with no associated Issue.
Requirements check-list
CONTRIBUTING.mdand added my name as a Code Contributor.setup.cfgandconda-environment.yml.