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.

Sign up for GitHub

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

Jump to bottom

Example download command in help docs is confusing #6

Open
bertday opened this issue Nov 20, 2023 · 0 comments
Open

Example download command in help docs is confusing #6

bertday opened this issue Nov 20, 2023 · 0 comments
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@bertday
Copy link
Contributor

bertday commented Nov 20, 2023

When you run

❯ bb bdc-availability download --help
Usage: index [options] <entity-type> <entity-ids> <filing-type> <output-dir>

the "usage" command starts with index. That's probably an artifact of how the project is structured and that the actual file name for the download command is index.html.
@bertday bertday added bug Something isn't working documentation Improvements or additions to documentation labels Nov 20, 2023
@bertday bertday changed the title Nested commands generate incomplete example in help docs Example download command in help docs is confusing Nov 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@bertday