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 command suggestions to follow style convention #2225

Closed
Tracked by #2239
AhdraMeraliQB opened this issue Jan 19, 2023 · 2 comments · Fixed by #2253
Closed
Tracked by #2239

Change docs command suggestions to follow style convention #2225

AhdraMeraliQB opened this issue Jan 19, 2023 · 2 comments · Fixed by #2253
Assignees

Comments

@AhdraMeraliQB
Copy link
Contributor

AhdraMeraliQB commented Jan 19, 2023

Description

As part of #2014 it was discovered that we are not consistent in how we format cli commands with flags. It was decided that we should be using kedro command --flag=value1,value2 and kedro command --flag='value with spaces 1, value with spaces 2'.

This will affect:
https://kedro.readthedocs.io/en/stable/development/commands_reference.html#modifying-a-kedro-run
https://kedro.readthedocs.io/en/stable/data/data_catalog.html#version-datasets-and-ml-models
https://kedro.readthedocs.io/en/stable/kedro_project_setup/configuration.html#specify-parameters-at-runtime
https://kedro.readthedocs.io/en/stable/get_started/new_project.html#create-a-new-project-from-a-configuration-file
https://kedro.readthedocs.io/en/stable/visualisation/kedro-viz_visualisation.html
https://kedro.readthedocs.io/en/stable/nodes_and_pipelines/run_a_pipeline.html#run-a-pipeline-by-name
https://kedro.readthedocs.io/en/stable/nodes_and_pipelines/slice_a_pipeline.html
https://kedro.readthedocs.io/en/stable/kedro_project_setup/configuration.html#configure-kedro-run-arguments
https://kedro.readthedocs.io/en/stable/deployment/dask.html

(This list may be incomplete)

Note: https://kedro.readthedocs.io/en/stable/development/commands_reference.html#modifying-a-kedro-run has a list of flags to modify kedro run. This list is missing --conf-source, --to-outputs, and --async. These should be added in (with the same formatting convention).

@stichbury
Copy link
Contributor

This all seems very reasonable to me @AhdraMeraliQB and I'd be happy to see these pages changed (ideally not to change them myself though, unless I'm supervised to ensure nothing is broken in the fix).

Some of these pages definitely need revision anyway (the configuration page is a key page) but it's probably best to do this task in one, and then go back to the pages and make improvements separately.

Feel free to put this into an upcoming sprint and I'll happily review.

@AhdraMeraliQB
Copy link
Contributor Author

Note: --conf-source was already added to the documentation in #2187 and is available on the latest build of the docs

@AhdraMeraliQB AhdraMeraliQB moved this from In Progress to In Review in Kedro Framework Jan 25, 2023
@github-project-automation github-project-automation bot moved this from In Review to Done in Kedro Framework Jan 30, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

3 participants