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

cfg: document recurrence graph addition in config #4066

Merged
merged 1 commit into from Feb 12, 2021

Conversation

oliver-sanders
Copy link
Member

Small change, realised that there is nothing in the config docs to explain the irregular behaviour of recurrence settings (now that they are settings not sections) so added a quick note.

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).
  • Does not need tests (why?).
  • No change log entry required (why? e.g. invisible to users).
  • No documentation update required.
  • No dependency changes.

@oliver-sanders oliver-sanders added small doc Documentation labels Feb 8, 2021
@oliver-sanders oliver-sanders added this to the cylc-8.0a3 milestone Feb 8, 2021
@oliver-sanders oliver-sanders self-assigned this Feb 8, 2021
Comment on lines 536 to +545
date-time cycling:
``T00,T06,T12,T18`` or ``PT6H`` - *every six hours*
* ``R1`` - once at the intial cycle point
* ``T00,T06,T12,T18`` - daily at 00:00, 06:00, 12:00
& 18:00
* ``PT6H`` - every six hours starting at the initial
cycle point
integer cycling:
``P2`` - *every other cycle*
* ``R1`` - once at the intial cycle point
* ``P2`` - every other cycle
* ``P3,P5`` - every third or fifth cycle
Copy link
Member

Choose a reason for hiding this comment

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

If you build this as is the formatting of integer cycling and date-time cycling is the same as that for config item.

Suggested change
date-time cycling:
``T00,T06,T12,T18`` or ``PT6H`` - *every six hours*
* ``R1`` - once at the intial cycle point
* ``T00,T06,T12,T18`` - daily at 00:00, 06:00, 12:00
& 18:00
* ``PT6H`` - every six hours starting at the initial
cycle point
integer cycling:
``P2`` - *every other cycle*
* ``R1`` - once at the intial cycle point
* ``P2`` - every other cycle
* ``P3,P5`` - every third or fifth cycle
date-time cycling:
* ``R1`` - once at the intial cycle point
* ``T00,T06,T12,T18`` - daily at 00:00, 06:00, 12:00
& 18:00
* ``PT6H`` - every six hours starting at the initial
cycle point
integer cycling:
* ``R1`` - once at the intial cycle point
* ``P2`` - every other cycle
* ``P3,P5`` - every third or fifth cycle

Copy link
Member Author

Choose a reason for hiding this comment

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

Yeah, I think that's a regression bug in the rtd theme, I seem to remember seeing an issue a while back, I thought it got fixed.

Your diff above converts the bullet point lists into block quotes. Would rather keep the RST correct and fix the rendering bug if possible.

definition list item:
    definition list description

plain text:

   blockquote

Copy link
Member Author

Choose a reason for hiding this comment

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

Here's the bug issue - readthedocs/sphinx_rtd_theme#800

It was fixed a while back but seems to be back, though in a slightly different form. Will try and find out if this is a design decision.

Just found this which may be somewhat related readthedocs/sphinx_rtd_theme#979 which is open.

Here's the intended appearance - https://sphinx-rtd-theme--981.org.readthedocs.build/en/981/demo/lists_tables.html#definition-lists

Copy link
Member Author

Choose a reason for hiding this comment

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

Digging a little deeper I think it is because the definition list is being documented within a domain.

Take this example:

Foo
   foo
Bar
   bar
Baz
   baz


.. py:class:: pub

   Arguments:
      foo: abc
      bar: bcd
      baz: def

   Foo
      foo
   Bar
      bar
   Baz
      baz

Which renders like this:

Screenshot 2021-02-12 at 12 37 55

Copy link
Member Author

Choose a reason for hiding this comment

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

Yep that's it.

However the definition style is still inconsistent with the others.

Copy link
Member Author

Choose a reason for hiding this comment

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

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.

The suggestion is tangential to the PR.

@wxtim
Copy link
Member

wxtim commented Feb 12, 2021

Having read your comments I'd be happy to merge. But if you'd rather I wait...

@oliver-sanders oliver-sanders merged commit 6176181 into cylc:master Feb 12, 2021
@oliver-sanders oliver-sanders deleted the rec-doc branch February 12, 2021 16:33
@hjoliver hjoliver modified the milestones: cylc-8.0a3, cylc-8.0b0 Feb 25, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Documentation small
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants