Skip to content

Commit

Permalink
Add link to list of job script env vars in [runtime][X]script docs (#…
Browse files Browse the repository at this point in the history
…4649)

Add link to job script env vars list in `[runtime][X]script` reference
  • Loading branch information
MetRonnie authored Feb 3, 2022
1 parent a105650 commit 9c52cff
Showing 1 changed file with 10 additions and 7 deletions.
17 changes: 10 additions & 7 deletions cylc/flow/cfgspec/workflow.py
Original file line number Diff line number Diff line change
Expand Up @@ -977,6 +977,16 @@ def get_script_common_text(this: str, example: Optional[str] = None):
If no parents are listed default is ``root``.
''')
Conf('script', VDR.V_STRING, desc=dedent('''
The main custom script invoked from the task job script.
It can be an external command or script, or inlined scripting.
See :ref:`Task Job Script Variables` for the list of variables
available in the task execution environment.
''') + get_script_common_text(
this='script', example='my_script.sh'
))
Conf('init-script', VDR.V_STRING, desc=dedent('''
Custom script invoked by the task job script before the task
execution environment is configured.
Expand Down Expand Up @@ -1036,13 +1046,6 @@ def get_script_common_text(this: str, example: Optional[str] = None):
this='pre-script',
example='echo "Hello from workflow ${CYLC_WORKFLOW_ID}!"'
))
Conf('script', VDR.V_STRING, desc=dedent('''
The main custom script invoked from the task job script.
It can be an external command or script, or inlined scripting.
''') + get_script_common_text(
this='script', example='my_script.sh'
))
Conf('post-script', VDR.V_STRING, desc=dedent('''
Custom script invoked by the task job script immediately
after :cylc:conf:`[..]script`.
Expand Down

0 comments on commit 9c52cff

Please sign in to comment.