Skip to content

Commit 9b84949

Browse files
committed
Update description of hflowRun parameters
1 parent cee95a1 commit 9b84949

File tree

1 file changed

+3
-6
lines changed

1 file changed

+3
-6
lines changed

common/wfRun.js

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -75,16 +75,13 @@ function hflow_start() {
7575
/*
7676
** Function hflowRun: run a workflow
7777
**
78-
** Parameters:
79-
** - wfVars -- values for '{{var}}' variables that may exist in workflow.json
80-
** - opts -- docopt JSON object from 'hflow' command with additional options:
78+
** Parameters are passed as 'opts' -- docopt JSON object from 'hflow' command:
8179
** '<workflow_dir_or_file>': (string/null) -- path to 'workflow'json' or directory that contains it
8280
** '--log-provenance': (true/false) -- if true, provenance will be logged
8381
** '--persist': (true/false) -- if true, workflow state will be persisted
8482
** '--provenance-output': (string/null) -- path to file where provenance should be saved (defaults to 'provenance_log.txt')
85-
** '--var': [],
86-
** '--with-server': (true/false) --
87-
** '-p': (true/false) --
83+
** '--var': (array of strings) -- some {{vars}} can be passed using this array
84+
** '-p': (true/false) -- if true, load plugin modules
8885
** '-s': (true/false) -- if true, initial signals to all workflow inputs will be sent (obsolete)
8986
** recover: (true/false) -- if true, this is a recovery mode (workflow is replayed from a recovery file)
9087
** '<persistence-log>': (string/null) -- name/path to the recovery file (must be set if 'recover' is true)

0 commit comments

Comments
 (0)