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.

Sign up for GitHub

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

Jump to bottom

Fix workflow state docs #6477

Open
wants to merge 1 commit into
base: 8.3.x
Choose a base branch
from
+7 −7
Open

Fix workflow state docs #6477

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions cylc/flow/scripts/workflow_state.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -296,8 +296,8 @@ def get_option_parser() -> COP:

parser.add_option(
"--triggers",
help="Task selector should match output triggers rather than status."
" (Note this is not needed for custom outputs).",
help="Task selector should match output trigger names rather than "
"status.",
action="store_true", dest="is_trigger", default=False)

parser.add_option(
Expand Down
10 changes: 5 additions & 5 deletions cylc/flow/xtriggers/workflow_state.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,12 +48,12 @@ def workflow_state(
e.g. PT1H (1 hour) or P1 (1 integer cycle)
flow_num:
Flow number of the target task.
is_message:
Interpret the task:selector as a task output message
(the default is a task status or trigger)
is_trigger:
Interpret the task:selector as a task trigger name
(only needed if it is also a valid status name)
Interpret the task:selector as a task trigger name rather than a
task status.
is_message:
Interpret the task:selector as a task output message rather than a
task status.
alt_cylc_run_dir:
Alternate cylc-run directory, e.g. for another user.

Expand Down
Loading