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

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

Merged
merged 32 commits into from
Apr 11, 2023
Merged
Show file tree
Hide file tree
Changes from 5 commits
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
22 changes: 4 additions & 18 deletions core/dbt/cli/params.py
Original file line number Diff line number Diff line change
Expand Up @@ -41,17 +41,10 @@
default=True,
)

compile_parse = click.option(
"--compile/--no-compile",
envvar=None,
help="TODO: No help text currently available",
default=True,
)
dbeatty10 marked this conversation as resolved.
Show resolved Hide resolved

config_dir = click.option(
"--config-dir",
envvar=None,
help="If specified, DBT will show path information for this project",
help="Show path information for this project",
type=click.STRING,
)

Expand Down Expand Up @@ -187,7 +180,7 @@
"--output",
"-o",
envvar=None,
help="Specify the output path for the json report. By default, outputs to 'target/sources.json'",
help="Specify the output path for the JSON report. By default, outputs to 'target/sources.json'",
type=click.Path(file_okay=True, dir_okay=False, writable=True),
default=PurePath.joinpath(Path.cwd(), "target/sources.json"),
)
Expand Down Expand Up @@ -366,7 +359,7 @@
state = click.option(
"--state",
envvar="DBT_STATE",
help="If set, use the given directory as the source for json files to compare with this project.",
help="If set, use the given directory as the source for JSON files to compare with this project.",
type=click.Path(
dir_okay=True,
file_okay=False,
Expand Down Expand Up @@ -484,13 +477,6 @@ def _version_callback(ctx, _param, value):
write_json = click.option(
"--write-json/--no-write-json",
envvar="DBT_WRITE_JSON",
help="Writing the manifest and run_results.json files to disk",
default=True,
)

write_manifest = click.option(
"--write-manifest/--no-write-manifest",
envvar=None,
help="TODO: No help text currently available",
help="Whether or not to write the manifest.json and run_results.json files to the target directory",
default=True,
)
4 changes: 2 additions & 2 deletions core/dbt/cli/requires.py
Original file line number Diff line number Diff line change
Expand Up @@ -144,8 +144,8 @@ def wrapper(*args, **kwargs):

def manifest(*args0, write=True, write_perf_info=False):
"""A decorator used by click command functions for generating a manifest
given a profile, project, and runtime config. This also registers the adaper
from the runtime config and conditionally writes the manifest to disc.
given a profile, project, and runtime config. This also registers the adapter
from the runtime config and conditionally writes the manifest to disk.
"""

def outer_wrapper(func):
Expand Down