Update docs and Release.md

Signed-off-by: Dmitry Sorokin <dmd40in@gmail.com>
kedro-org · Jan 14, 2024 · 34e66c3 · 34e66c3
1 parent b49b243
commit 34e66c3
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 2 deletions.
diff --git a/RELEASE.md b/RELEASE.md
@@ -11,6 +11,7 @@
 
 ## Breaking changes to the API
 * Added logging about not using async mode in `SequentiallRunner` and `ParallelRunner`.
+* Changed input format for tools option obtained from --config file from numbers to short names.
 
 ## Documentation changes
 * Added documentations about `bootstrap_project` and `configure_project`.

diff --git a/docs/source/starters/index.md b/docs/source/starters/index.md
@@ -32,7 +32,7 @@ The configuration file must contain:
 
 Additionally, the configuration file may contain:
 
-* `tools`: The tools to customise your project setup with. Select from comma-separated values, ranges, or 'all/none'. Omitting this from your configuration file will result in the default selection of `none`.
+* `tools`: The tools to customise your project setup with. Select from comma-separated values `lint, test, log, docs, data, pyspark, viz` or `all/none`. Omitting this from your configuration file will result in the default selection of `none`.
 * `example`: Indicate `yes` or `no` to select whether you would like your project to be populated with example code. Omitting this from your configuration file will result in the default selection of `no`.
 
 The `output_dir` can be specified as `~` for the home directory or `.` for the current working directory. Here is an example `config.yml`, which assumes that a directory named `~/code` already exists:

diff --git a/docs/source/starters/new_project_tools.md b/docs/source/starters/new_project_tools.md
@@ -137,7 +137,7 @@ As an alternative to the interactive project creation workflow, you can also sup
     "my project"
 
 "tools":
-    "2-6"
+    "lint, test, log, docs, data, pyspark, viz"
 
 "example_pipeline":
     "y"