parsec: add help for coercers (data types) #3439
Merged
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
* add doctests for each coercer * make all coercers classmethods * document coercers * test examples in documentation
oliver-sanders
commented
Nov 15, 2019
| }, | ||
| [ | ||
| ('std:term', 'cycle point'), | ||
| ('std:term', 'ISO8601 duration') |
There was a problem hiding this comment.
These are reference-able items in the Cylc documentation.
| @@ -550,9 +801,16 @@ def coerce_cycle_point_time_zone(cls, value, keys): | |||
| 'cycle point time zone format', keys, value) | |||
| return value | |||
|
|
|||
| def coerce_interval(self, value, keys): | |||
| """Coerce an ISO 8601 interval (or number: back-comp) into seconds.""" | |||
There was a problem hiding this comment.
Looks like this back-comp documentation is out of date?
Have removed.
| @@ -155,3 +155,12 @@ def get_signature(self): | |||
| args = self.func_args + [ | |||
| "%s=%s" % (i, self.func_kwargs[i]) for i in skeys] | |||
| return "%s(%s)" % (self.func_name, ", ".join([str(a) for a in args])) | |||
|
|
|||
| def __str__(self): | |||
There was a problem hiding this comment.
Represents a sub proc context thinggy like this:
func(arg):interval
Tested in coerce_xtrigger.
kinow
approved these changes
Nov 16, 2019
hjoliver
approved these changes
Nov 29, 2019
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.
Document the parsec "types" from within Pasec for use by autodocumentation systems.
Trying for the simplest, least hassle way of doing this, in the long run we will want to refactor things somewhat. At Cylc9 we may well brush this code aside entirely.
This documentation will be used to generate reference material like this:
These changes partially address #3253, cylc/cylc-doc#101
Requirements check-list
CONTRIBUTING.mdand added my name as a Code Contributor.