Skip to content
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

Change docs to use plural flags in kedro run suggestions and examples #2246

Closed
AhdraMeraliQB opened this issue Jan 23, 2023 · 1 comment · Fixed by #2315
Closed

Change docs to use plural flags in kedro run suggestions and examples #2246

AhdraMeraliQB opened this issue Jan 23, 2023 · 1 comment · Fixed by #2315
Assignees
Labels
Component: Documentation 📄 Issue/PR for markdown and API documentation

Comments

@AhdraMeraliQB
Copy link
Contributor

Description

Prerequisites: #2243 and #2244

We are switching over to using plural flags to replace --node, --tag, and --load-version. These changes should also be reflected in the docs wherever we give examples of using these flags.

Additionally, the use of these plural flags affects the docs on using config.yml for kedro runs: nodes and tags will no longer take lists, instead they should take comma separated arguments. See #1792 (comment) for further context. As a result, https://kedro.readthedocs.io/en/stable/kedro_project_setup/configuration.html#configure-kedro-run-arguments should also be updated under this ticket.

@AhdraMeraliQB
Copy link
Contributor Author

AhdraMeraliQB commented Jan 24, 2023

Note: The table of commands on the docs page https://kedro.readthedocs.io/en/stable/development/commands_reference.html#modifying-a-kedro-run has a column titled "Multiple instances allowed?". This should be removed as no commands will have multiple instances allowed anymore, making this column redundant.

The column has been removed (see this comment) so the edit here would now be to delete the extra sentence "Multiple instances allowed" from the relevant decriptions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Documentation 📄 Issue/PR for markdown and API documentation
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

3 participants