-
Notifications
You must be signed in to change notification settings - Fork 19
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.
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
Update docs for implicit/naked tasks #207
Merged
Merged
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
36a1e26
Update docs for implicit tasks
MetRonnie 6eaea24
Address code review
MetRonnie 303fef3
Allow implicit tasks in tutorials/guides
MetRonnie 57db3c1
Remove use of term "dummy task"
MetRonnie 055dc86
Fix implicit tasks in workflow files
MetRonnie 5372043
Remove --strict option from cylc validate
MetRonnie File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -390,7 +390,7 @@ Remote Task Hosting | |||||
------------------- | ||||||
|
||||||
If a task declares a different platform to the one running the workflow, | ||||||
Cylc will use non-interactive ssh to execute the task using the | ||||||
Cylc will use non-interactive ssh to execute the task using the | ||||||
:term:`job runner` and one of the hosts from the :term:`platform` definition | ||||||
(platforms are defined in ``global.cylc[platforms]``). | ||||||
|
||||||
|
@@ -444,27 +444,30 @@ Remote task log directories, like local ones, are created on the fly, if | |||||
necessary, during job submission. | ||||||
|
||||||
|
||||||
Naked Dummy Tasks And Strict Validation | ||||||
--------------------------------------- | ||||||
.. _ImplicitTasks: | ||||||
|
||||||
A *naked dummy task* appears in the suite graph but has no | ||||||
Implicit Tasks | ||||||
-------------- | ||||||
|
||||||
An :term:`implicit task` appears in the workflow graph but has no | ||||||
explicit runtime configuration section. Such tasks automatically | ||||||
inherit the default "dummy task" configuration from the root | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
namespace. This is very useful because it allows functional suites to | ||||||
be mocked up quickly for test and demonstration purposes by simply | ||||||
defining the graph. It is somewhat dangerous, however, because there | ||||||
is no way to distinguish an intentional naked dummy task from one | ||||||
generated by typographic error: misspelling a task name in the graph | ||||||
results in a new naked dummy task replacing the intended task in the | ||||||
affected trigger expression; and misspelling a task name in a runtime | ||||||
section heading results in the intended task becoming a dummy task | ||||||
is no way to distinguish an intentional implicit task from one | ||||||
caused by typographic error. Misspelling a task name in the graph | ||||||
results in a new implicit task replacing the intended task in the | ||||||
affected trigger expression, and misspelling a task name in a runtime | ||||||
section heading results in the intended task becoming an implicit task | ||||||
itself (by divorcing it from its intended runtime config section). | ||||||
|
||||||
To avoid this problem any dummy task used in a real suite should not be | ||||||
naked - i.e. it should have an explicit entry in under the runtime | ||||||
section of the suite configuration, even if the section is empty. This | ||||||
results in exactly the same dummy task behaviour, via implicit | ||||||
inheritance from root, but it allows use of | ||||||
``cylc validate --strict`` | ||||||
to catch errors in task names by failing the suite if any naked dummy | ||||||
tasks are detected. | ||||||
You can allow implicit tasks during development of a workflow using | ||||||
:cylc:conf:`flow.cylc[scheduler]allow implicit tasks`. But, to avoid | ||||||
the problems mentioned above, any task used in a production/operational | ||||||
workflow should not be implicit, i.e. it should have an explicit entry in under | ||||||
the runtime section of ``flow.cylc``, even if the section is empty. This | ||||||
results in exactly the same dummy task behaviour, via inheritance from root, | ||||||
but adds a layer of protection against mistakes. Thus, it is recommended to | ||||||
turn off :cylc:conf:`flow.cylc[scheduler]allow implicit tasks` when the | ||||||
:cylc:conf:`flow.cylc[runtime]` section has been written. |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What about changing the first line to "Implicit tasks (previously known as naked tasks)..."
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could do, however, the terminology before was a mixture of,
dummy
(incorrect),naked
(strange) andnaked-dummy
(really strange and somewhat suggestive).