You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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 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.
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
andkedro 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).The text was updated successfully, but these errors were encountered: