-
Notifications
You must be signed in to change notification settings - Fork 19
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 cycling docs #454
Improve cycling docs #454
Conversation
Format 3: ``R[limit?]/[datetime]/[interval]`` | ||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It feels a bit awkward talking about format 3, then 4, then 1. But that's probably the most sensible order
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Perhaps a quick note just underneath the title giving a reason? Especially as the first sentence is that reason anyway...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Very nicely explained!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've added some suggestions - I've approved because I think that the changes are a good idea, but not worth blocking the PR for (especially the idea of turning examples into tables which would require a certain amount of effort).
I think that the English language translations could be useful to some readers.
Format 3: ``R[limit?]/[datetime]/[interval]`` | ||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Perhaps a quick note just underneath the title giving a reason? Especially as the first sentence is that reason anyway...
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
|
||
Another supported recurrence form is: | ||
``R[limit?]/[interval]/[datetime]`` (format number 4 in the ISO 8601 standard). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A second reason why the section order and the format number don't match to add to the note at the top of the Format3 section?
Sibling to cylc/cylc-flow#4554
Also addresses comment from Element:
Requirements check-list
CONTRIBUTING.md
and added my name as a Code Contributor.