Add documentation for xtriggers entry_point #671
Conversation
ColemanTom
force-pushed
the
entry_points_xtriggers
branch
from
9f6f117 to
4d1b766
Compare
ColemanTom
force-pushed
the
entry_points_xtriggers
branch
from
4d1b766 to
a26376a
Compare
src/plugins/xtriggers/index.rst
Outdated
| :template: docstring_only.rst | ||
|
|
||
| cylc.flow.xtriggers.echo | ||
| cylc.flow.xtriggers.wall_clock |
There was a problem hiding this comment.
Unfortunately the fly in the ointment here is that the wall_clock function has a different signature in the code compared to real usage. Not sure what the reason for this was, but it was done in cylc/cylc-flow#4511. Maybe @hjoliver will be able to shed some light
There was a problem hiding this comment.
I don't really understand this, outside my area of knowledge. Do I need to change anything or await advice from @hjoliver ?
There was a problem hiding this comment.
I think it would be good if Hilary could chime in, also I seem to remember he has a draft PR that somewhat rewrites the function
There was a problem hiding this comment.
The wall_clock xtrigger isn't really an xtrigger because it would be inefficient to call this function in a subprocess over and over. So instead it's actually run synchronously within the main code, the trigger time is computed from the offset and the cycle point in advance to avoid excess computation.
This sort of problem will go away with cylc/cylc-flow#3497 as this will avoid polling a function allowing it to maintain local state.
Until then, maybe just subtract the wall_clock function from the autodocumented reference.
There was a problem hiding this comment.
Thanks, removed wall_clock. I also noticed I had PYTHONPATH instead of CYLC_PYTHONPATH, so I updated that too.
Co-authored-by: Ronnie Dutta <61982285+MetRonnie@users.noreply.github.com>
ColemanTom
force-pushed
the
entry_points_xtriggers
branch
from
5c21b65 to
368818c
Compare
|
test failure is casued by openbsd website being down. Nothing I can do to fix that. It could change to the freebsd version of the |
|
Could you add |
Done |
|
@oliver-sanders Are you happy with my single review or did you want to re-review? |
Requirements check-list
CONTRIBUTING.mdand added my name as a Code Contributor.I've attempted to add documentation for new functionality provided by cylc/cylc-flow#5831. I hope it works properly. I think there should be a link between the external triggers documentation and the plugin documentation, but I'm not sure how to do that. Very specific advice would be appreciated.
When I tried to build this as myself I had issues and have not had time to try and debug, so I'm not sure how it renders (or if it is even valid).