From 34e66c3bd3ad1784c62d182d95c1d415451436d4 Mon Sep 17 00:00:00 2001 From: Dmitry Sorokin Date: Sun, 14 Jan 2024 21:27:20 +0000 Subject: [PATCH] Update docs and Release.md Signed-off-by: Dmitry Sorokin --- RELEASE.md | 1 + docs/source/starters/index.md | 2 +- docs/source/starters/new_project_tools.md | 2 +- 3 files changed, 3 insertions(+), 2 deletions(-) diff --git a/RELEASE.md b/RELEASE.md index abc4e324c0..21feb034d2 100644 --- 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 index 4cdb5a2d74..110633db85 100644 --- 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 index 1de6a1a1f3..2d768d7698 100644 --- 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"