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

Update docs with new Arguments help section #124

Closed
tiangolo opened this issue Jun 25, 2020 · 1 comment · Fixed by #135
Closed

Update docs with new Arguments help section #124

tiangolo opened this issue Jun 25, 2020 · 1 comment · Fixed by #135
Labels
feature New feature, enhancement or request good first issue Good for newcomers

Comments

@tiangolo
Copy link
Member

The new support for help parameters in CLI arguments from #123 changes how the help text is generated with CLI arguments.

It also now shows default values by default.

So, many of the demos showing how it would look like in the terminal have to be updated to show the new real output.

  • Any example that has CLI arguments and uses --help will change.
  • And any example that has a default value for CLI arguments or CLI options and uses --help, will change too.

The task here is to read all the docs, page by page, and copy the code in the example, run the same commands as in the demonstration and update the output (copy it from the terminal) to the docs when it changes.

In most/all of the cases, it should require just to copy the example code, run it with the example commands, and copy the output back in the docs.

But it requires a lot of attention to the details to make sure not to skip/forget any example that also changes, to preserve the demonstration comments and guides, and to recognize when there are changes.

And the changes are probably a lot, spread through all the docs 😅

@tiangolo tiangolo added feature New feature, enhancement or request good first issue Good for newcomers labels Jun 25, 2020
@victorphoenix3
Copy link
Contributor

I could work on this! :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New feature, enhancement or request good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants