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

xtriggers: documentation #3457

Merged
merged 1 commit into from
Dec 2, 2019
Merged

Conversation

oliver-sanders
Copy link
Member

Provide Xtriggers with docstrings suitable for auto-documentation via Sphinx.

Part-addresses cylc/cylc-xtriggers#4

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.

@oliver-sanders oliver-sanders added the doc Documentation label Nov 29, 2019
@oliver-sanders oliver-sanders added this to the cylc-8.0a2 milestone Nov 29, 2019
@oliver-sanders oliver-sanders self-assigned this Nov 29, 2019
Copy link
Member

@kinow kinow left a comment

Choose a reason for hiding this comment

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

Just one question about isodatetime pkg. Everything else looks good! Thanks!

cylc/flow/xtriggers/suite_state.py Outdated Show resolved Hide resolved
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.

Looks good; but not merging response to @kinow 's question. (Note we'll also need the "built-in" xtriggers documented in the User Guide - maybe they already are, I forget - along with how to do custom xtriggers via entry points).

@hjoliver hjoliver merged commit 00eb47e into cylc:master Dec 2, 2019
@oliver-sanders oliver-sanders deleted the xtrigger-docs branch December 3, 2019 10:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants