Autodoc built-in xtrigger functions #673
Closed
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
8 tasks
|
Note, this PR will conflict with #671 which also auto-documents xtriggers, but in the plugins section (the xtriggers section is more appropriate). We could probably do with pulling any relevant text out of cylc-doc and into the xtrigger docstrings to keep it all together? For maintainability, I think we should probably go along the same lines at the job runner handlers and put the https://github.com/cylc/cylc-flow/blob/master/cylc/flow/job_runner_handlers/__init__.py |
|
Closes #106 |
|
Superseded by #686 |
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.
The
debugarg is not around anymore. By autofunction'ing, these will always be valid. The downside is pulling in the docstring is quite verbose...Requirements check-list
CONTRIBUTING.mdand added my name as a Code Contributor.