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

Fix docstring for dbt docs generate #2038

Closed
4 tasks
gnilrets opened this issue Jan 9, 2020 · 1 comment · Fixed by #2105
Closed
4 tasks

Fix docstring for dbt docs generate #2038

gnilrets opened this issue Jan 9, 2020 · 1 comment · Fixed by #2105
Labels
bug Something isn't working cli good_first_issue Straightforward + self-contained changes, good for new contributors!

Comments

@gnilrets
Copy link

gnilrets commented Jan 9, 2020

Describe the bug

The docstring for dbt docs seems to indicate that if you want to use a different target, you would put the --target parameter before generate:

# dbt docs -h
usage: dbt docs [-h] [--project-dir PROJECT_DIR] [--profiles-dir PROFILES_DIR] [--profile PROFILE] [--target TARGET] [--vars VARS] [--bypass-cache] {generate,serve} ...

However, when I try that, it doesn't honor the parameter

# dbt docs --target prod generate
Running with dbt=0.14.3
Found 125 models, 207 tests, 15 snapshots, 0 analyses, 254 macros, 2 operations, 3 seed files, 101 sources
19:31:38 | Concurrency: 4 threads (target='dev')

However, if I put the flag at the end like this, it works fine:

# dbt docs generate --target prod

Steps To Reproduce

See above

Expected behavior

The docs should be in alignment with the actual commands.

Screenshots and log output

See above

System information

Which database are you using dbt with?

  • postgres
  • [x ] redshift
  • bigquery
  • snowflake
  • other (specify: ____________)

The output of dbt --version:

installed version: 0.14.3

The operating system you're using: Debian GNU/Linux 10 (buster)

The output of python --version: 3.6.9

Additional context

@gnilrets gnilrets added bug Something isn't working triage labels Jan 9, 2020
@drewbanin drewbanin added cli and removed triage labels Jan 20, 2020
@drewbanin drewbanin added this to the Barbara Gittings milestone Jan 20, 2020
@drewbanin
Copy link
Contributor

Thanks for the report @gnilrets! I think this should be a quick fix - I just queued this up for our 0.16.0 release. Let me know if it's something you would be interested in contributing a fix for!

@drewbanin drewbanin added the good_first_issue Straightforward + self-contained changes, good for new contributors! label Jan 20, 2020
beckjake added a commit that referenced this issue Feb 10, 2020
…d-docs

Fix docstring for dbt docs/source to not include misleading flags (#2038)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working cli good_first_issue Straightforward + self-contained changes, good for new contributors!
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants