[WIP] Review Docs in light of config changes #175
Closed
Conversation
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
|
@dpmatthews @oliver-sanders @hjoliver - this PR is still in draft form, but I'm tagging you so that you can see I'm having a good look at this stuff. It's by no means finished atm. |
wxtim
commented
Dec 2, 2020
| A Cylc suite is a directory containing a :cylc:conf:`flow.cylc` file | ||
| workflow | ||
| Cylc workflow | ||
| A Cylc workflow is a directory containing a :cylc:conf:`flow.cylc` file |
There was a problem hiding this comment.
This isn't really what a workflow is, but how it's defined.
Suggested change
| A Cylc workflow is a directory containing a :cylc:conf:`flow.cylc` file | |
| A Cylc workflow is a way of organizing one or more programs, specifying relationships between them. Is is defined in a directory containing a :cylc:conf:`flow.cylc` file. |
wxtim
commented
Dec 2, 2020
Comment on lines
+13
to
15
| The workflow directory contains all of the configuration for a workflow e.g. | ||
| the :cylc:conf:`flow.cylc` file. | ||
|
|
There was a problem hiding this comment.
Suggested change
| The workflow directory contains all of the configuration for a workflow e.g. | |
| the :cylc:conf:`flow.cylc` file. | |
| The workflow directory contains all of the configuration for a workflow. | |
| In its most basic form the workflow directory will contain a :cylc:conf:`flow.cylc` file. |
|
Did you intend to close this @wxtim ? |
Yep. It suffered massive mission creep |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
I've added suggestion comments in places where I see the possibility of making changes which I believe may spark debate.
Pre-requisites: