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 cycling docs #454

Merged
merged 3 commits into from
Apr 13, 2022
Merged

Improve cycling docs #454

merged 3 commits into from
Apr 13, 2022

Conversation

MetRonnie
Copy link
Member

@MetRonnie MetRonnie commented Apr 6, 2022

Sibling to cylc/cylc-flow#4554

Also addresses comment from Element:

Graphviz comes with a conda install. But we should list it as a non-Python dependency for pip install

Requirements check-list

  • I have read CONTRIBUTING.md and added my name as a Code Contributor.

@MetRonnie MetRonnie added the content Addition or modification of documentation label Apr 6, 2022
@MetRonnie MetRonnie added this to the 8.0rc3 milestone Apr 6, 2022
@MetRonnie MetRonnie self-assigned this Apr 6, 2022
Comment on lines +329 to +330
Format 3: ``R[limit?]/[datetime]/[interval]``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Copy link
Member Author

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

Copy link
Member

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...

Copy link
Member

@hjoliver hjoliver left a comment

Choose a reason for hiding this comment

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

Very nicely explained!

Copy link
Member

@wxtim wxtim left a 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.

Comment on lines +329 to +330
Format 3: ``R[limit?]/[datetime]/[interval]``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Copy link
Member

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...

src/user-guide/writing-workflows/scheduling.rst Outdated Show resolved Hide resolved
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Another supported recurrence form is:
``R[limit?]/[interval]/[datetime]`` (format number 4 in the ISO 8601 standard).
Copy link
Member

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?

@wxtim wxtim merged commit 66361d4 into cylc:master Apr 13, 2022
@MetRonnie MetRonnie deleted the cycling branch April 13, 2022 09:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content Addition or modification of documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants