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

Fixed inconsistencies in --help #10074

Closed
wants to merge 2 commits into from
Closed

Conversation

CmdP1rx
Copy link

@CmdP1rx CmdP1rx commented May 1, 2024

resolves #10073

Problem

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

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.

Solution

I have fixed and formatted all help options. Now, files are using single quotes ' and commands and their parts are using single ticks `.
Examples:
Specify number of threads to use while executing models. Overrides settings in 'profiles.yml'.
Specify the format of logging to the log file by overriding the default value and the general `--log-format` setting.

Checklist

  • I have read the contributing guide and understand what's expected of me
  • I have run this code in development and it appears to resolve the stated issue
  • This PR includes tests, or tests are not required/relevant for this PR
  • This PR has no interface changes (e.g. macros, cli, logs, json artifacts, config files, adapter interface, etc) or this PR has already received feedback and approval from Product or DX
  • This PR includes type annotations for new and modified functions

@CmdP1rx CmdP1rx requested a review from a team as a code owner May 1, 2024 22:43
Copy link

cla-bot bot commented May 1, 2024

Thanks for your pull request, and welcome to our community! We require contributors to sign our Contributor License Agreement and we don't seem to have your signature on file. Check out this article for more information on why we have a CLA.

In order for us to review and merge your code, please submit the Individual Contributor License Agreement form attached above above. If you have questions about the CLA, or if you believe you've received this message in error, please reach out through a comment on this PR.

CLA has not been signed by users: @CmdP1rx

Copy link
Contributor

github-actions bot commented May 1, 2024

Thank you for your pull request! We could not find a changelog entry for this change. For details on how to document a change, see the contributing guide.

@github-actions github-actions bot added the community This PR is from a community member label May 1, 2024
@CmdP1rx CmdP1rx closed this May 1, 2024
@CmdP1rx CmdP1rx deleted the update-help-cli branch May 1, 2024 23:07
@CmdP1rx CmdP1rx restored the update-help-cli branch May 1, 2024 23:08
@CmdP1rx CmdP1rx reopened this May 1, 2024
@CmdP1rx CmdP1rx closed this May 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
community This PR is from a community member
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug] Inconsitencies with descriptions with --help
1 participant