dbt-labs/dbt-core

[Bug] Inconsitencies with descriptions with `--help`

CmdP1rx opened this issue · 0 comments

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