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.

Sign up for GitHub

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

Jump to bottom

Update help text for commands + params in CLI and top-level API #7176

Merged
merged 32 commits into from
Apr 11, 2023
Merged

Update help text for commands + params in CLI and top-level API #7176

Changes from 1 commit
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
3e2d549
Removed options for `dbt parse`
dbeatty10 Mar 16, 2023
405fe96
Fix misspellings
dbeatty10 Mar 16, 2023
322b430
Capitalize JSON when appropriate
dbeatty10 Mar 16, 2023
5b54a51
Update help text for --write-json/--no-write-json
dbeatty10 Mar 16, 2023
0d47722
Update help text for --config-dir
dbeatty10 Mar 16, 2023
9e0a0db
Update help text for --resource-types
dbeatty10 Mar 16, 2023
b94cdd6
Removed decorators for removed dbt parse options
dbeatty10 Mar 27, 2023
9938dd1
Remove `--write-manifest` flag from `parse`
dbeatty10 Mar 27, 2023
01db919
Remove `--parse-only` flag from `compile`
dbeatty10 Mar 27, 2023
0da3f99
Update help text for `dbt list --output`
dbeatty10 Mar 27, 2023
7d3213b
Standardize on one line per argument
dbeatty10 Mar 27, 2023
7632e0a
Factor 3 from 12 Factor CLI Apps
dbeatty10 Mar 27, 2023
6a443c0
Update help text for `dbt --version`
dbeatty10 Mar 27, 2023
e7f6144
Standardize capitalization of resource types for `dbt build`
dbeatty10 Mar 27, 2023
edaa1df
`debug --config-dir` is a boolean flag
dbeatty10 Mar 28, 2023
1f9eb0a
Update help text for `--version-check`
dbeatty10 Mar 28, 2023
45ec185
Specify `-q` as a conventional alias for `--quiet`
dbeatty10 Mar 28, 2023
8170ff2
Update help text for `debug --config-dir`
dbeatty10 Mar 28, 2023
a83e9b9
Update help text for `debug`
dbeatty10 Mar 28, 2023
5ee6580
Treat more dense text blobs as binary for `git grep`
dbeatty10 Apr 7, 2023
c8a686c
Update help text for `--version-check`
dbeatty10 Apr 7, 2023
599011e
Update help text for `--defer`
dbeatty10 Apr 7, 2023
308d32f
Update help text for `--indirect-selection`
dbeatty10 Apr 7, 2023
aa35c74
Co-locate log colorization with other log settings
dbeatty10 Apr 7, 2023
3097cf3
Update help text for `--log-format*`, `--log-level*`, and `--use-colo…
dbeatty10 Apr 7, 2023
8bb2cac
Merge branch 'main' into dbeatty/6546-param-help-text
dbeatty10 Apr 7, 2023
8e2ab31
Temporarily re-add option for CI tests
dbeatty10 Apr 7, 2023
2a715f4
Merge branch 'dbeatty/6546-param-help-text' of github.com:dbt-labs/db…
dbeatty10 Apr 7, 2023
e431e8c
Remove `--parse-only` flag from `show`
dbeatty10 Apr 7, 2023
156269c
Merge branch 'main' into dbeatty/6546-param-help-text
dbeatty10 Apr 11, 2023
fe0ec9c
Merge branch 'main' into dbeatty/6546-param-help-text
dbeatty10 Apr 11, 2023
5a21f3a
Remove `--write-manifest` flag from `parse` (again)
dbeatty10 Apr 11, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions core/dbt/cli/params.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,46 +117,46 @@
log_format = click.option(
"--log-format",
envvar="DBT_LOG_FORMAT",
help="Specify the log format, overriding the command's default.",
help="Specify the format of logging to the console and the log file. Use --log-format-file to configure the format for the log file differently than the console.",
dbeatty10 marked this conversation as resolved.
Show resolved Hide resolved
type=click.Choice(["text", "debug", "json", "default"], case_sensitive=False),
default="default",
)

log_format_file = click.option(
"--log-format-file",
envvar="DBT_LOG_FORMAT_FILE",
help="Specify the file log format, overriding the command's default and the value of --log-format.",
help="Specify the format of logging to the log file by overriding the default value and the general --log-format setting.",
type=click.Choice(["text", "debug", "json", "default"], case_sensitive=False),
default="debug",
)

log_level = click.option(
"--log-level",
envvar="DBT_LOG_LEVEL",
help="Specify the minimum severity of events that are logged.",
help="Specify the minimum severity of events that are logged to the console and the log file. Use --log-level-file to configure the severity for the log file differently than the console.",
type=click.Choice(["debug", "info", "warn", "error", "none"], case_sensitive=False),
default="info",
)

log_level_file = click.option(
"--log-level-file",
envvar="DBT_LOG_LEVEL_FILE",
help="Specify the minimum severity of events that are logged to file, overriding the value of --log-level-file.",
help="Specify the minimum severity of events that are logged to the log file by overriding the default value and the general --log-level setting.",
type=click.Choice(["debug", "info", "warn", "error", "none"], case_sensitive=False),
default="debug",
)

use_colors = click.option(
"--use-colors/--no-use-colors",
envvar="DBT_USE_COLORS",
help="Specify whether log output is colorized.",
help="Specify whether log output is colorized in the console and the log file. Use --use-colors-file/--no-use-colors-file to colorize the log file differently than the console.",
default=True,
)

use_colors_file = click.option(
"--use-colors-file/--no-use-colors-file",
envvar="DBT_USE_COLORS_FILE",
help="Specify whether log file output is colorized overriding --use-colors/--no-use-colors.",
help="Specify whether log file output is colorized by overriding the default value and the general --use-colors/--no-use-colors setting.",
default=True,
)

Expand Down