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

Add missing documentation to typer apps #12

Open
MarcSkovMadsen opened this issue Oct 9, 2022 · 0 comments
Open

Add missing documentation to typer apps #12

MarcSkovMadsen opened this issue Oct 9, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@MarcSkovMadsen
Copy link
Contributor

MarcSkovMadsen commented Oct 9, 2022 •
edited

When you run pn --help you see something like this

image

I've maked some commands that do not have documentation. I would like that added.

The commands that don't have documentation are coming from the .add_typer commands marked below.

image

So the task is to figure out how to add docs to those and add it.

You can find the .add_typer code here.

Accept Criteria

  • [] Technical solution found
  • [] Docs added. Also, for nested commands.
@MarcSkovMadsen MarcSkovMadsen added documentation Improvements or additions to documentation good first issue Good for newcomers labels Oct 9, 2022
@MarcSkovMadsen MarcSkovMadsen changed the title Add documentation to typer apps Add missing documentation to typer apps Oct 9, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@MarcSkovMadsen