Update docs with plural kedro run flags (load_versions, tags, nodes)
#2315
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
Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com>
stichbury
approved these changes
Feb 14, 2023
merelcht
reviewed
Feb 14, 2023
| | `kedro run --async` | Load and save node inputs and outputs asynchronously with threads | | ||
| | `kedro run --env=<env_name>` | Run the pipeline in the env_name environment. Defaults to local if not provided | | ||
| | [DEPRECATED] `kedro run --tag=<tag_name1>,<tag_name2>` | Run only nodes which have any of these tags attached. <br /> Multiple instances allowed. | | ||
| | `kedro run --tags=<tag_name1>,<tag_name2>` | Run only nodes which have any of these tags attached. <br /> NOTE: This flag will be deprecated in `Kedro 0.19.0`. Use the following flag `--tags` instead. | |
There was a problem hiding this comment.
I think the note is on the wrong line here. It should be in the for above.
There was a problem hiding this comment.
Yes, I put it in the wrong place. Made the change in dd12b68
AhdraMeraliQB
approved these changes
Feb 14, 2023
| node_names: | ||
| - node1 | ||
| - node2 | ||
| nodes_names: node1, node2 |
There was a problem hiding this comment.
Just a note: This will end up being changed back to node_names but better to have the change here as is, as the format of the command changes too.
Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com>
stichbury
pushed a commit
that referenced
this pull request
Feb 28, 2023
…nodes`) (#2315) * Update docs with plural flags Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com> * Move deprecation note to the right place Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com> --------- Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com> Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
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.
Signed-off-by: Ankita Katiyar ankitakatiyar2401@gmail.com
Description
Resolves #2246
Documentation for changes introduced in #2301 and #2303
Development notes
Docs changed in the following places -
kedro runoptions table indocs/source/development/commands_reference.mdconfig.ymlexample updated to use comma separated values instead of list format with the new flags indocs/source/kedro_project_setup/configuration.mdkedro runcommand that usednodeflag in the spaceflights tutorialdocs/source/tutorial/create_a_pipeline.mdChecklist
RELEASE.mdfile