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

[Bug] Inconsitencies with descriptions with --help #10073

Closed
2 tasks done
CmdP1rx opened this issue May 1, 2024 · 0 comments
Closed
2 tasks done

[Bug] Inconsitencies with descriptions with --help #10073

CmdP1rx opened this issue May 1, 2024 · 0 comments
Labels
bug Something isn't working

Comments

@CmdP1rx
Copy link

CmdP1rx commented May 1, 2024

Is this a new bug in dbt-core?

  • I believe this is a new bug in dbt-core
  • I have searched the existing issues, and I could not find an existing issue for this bug

Current Behavior

When using dbt --help, there are inconsistencies with punctuation and descriptions of files, with or without single quotes ' ', and flags with or without ticks `.

Some examples of inconsistencies:

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.
Whether or not to run 'dbt compile' as part of docs generation
Space-delimited listing of node properties to include as custom keys for JSON output (e.g. `--output json --output-keys name resource_type description`)
Specify number of threads to use while executing models. Overrides settings in profiles.yml.

Expected Behavior

Ensure consistent indication of commands, files, and flags in the --help
Like in:

Specify number of threads to use while executing models. Overrides settings in 'profiles.yml'.
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.

Steps To Reproduce

run
dbt --help

Relevant log output

No response

Environment

- OS: All Platforms
- Python: Python 3.11.8
- dbt: .7.13

Which database adapter are you using with dbt?

No response

Additional Context

No response

@CmdP1rx CmdP1rx added bug Something isn't working triage labels May 1, 2024
@CmdP1rx CmdP1rx closed this as not planned Won't fix, can't repro, duplicate, stale May 1, 2024
@dbeatty10 dbeatty10 removed the triage label May 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants