Skip to content

/ python-fire

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

Jump to bottom

Issue 259: Add :key: parameters to help string #275

Open
wants to merge 3 commits into
base: master
from
Open

Issue 259: Add :key: parameters to help string #275

wants to merge 3 commits into from

Conversation

@amy-lei
Copy link

@amy-lei amy-lei commented Jul 27, 2020 •
edited

Resolves #259

Add :key: parameters under flags as so

FLAGS
    --arg=ARG
    The following flags are also accepted.
    --key
        Description of the `key` kwarg from the docstring
    Additional undocumented flags may also be accepted.
@amy-lei
Add :key type name: parameters to help text
Loading status checks…
a22cb7d 
Remove unused code
@google-cla google-cla bot added the cla: yes label Jul 27, 2020
amy-lei added 2 commits Aug 3, 2020
@amy-lei
Use string formatting instead of f-string
Loading status checks…
26aba55
@amy-lei
Add tests for doctstring and helptext
Loading status checks…
9bcccf9
@amy-lei amy-lei marked this pull request as ready for review Aug 3, 2020
@dbieber
Copy link
Member

@dbieber dbieber commented Aug 5, 2020

Thanks for the PR! I haven't had a chance to look in detail yet. Will let you know once I do.
🙏
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
cla: yes
Projects
None yet
Milestone
No milestone
Linked issues

Successfully merging this pull request may close these issues.

:key: parameter documentation doesn't correctly display in help signature
2 participants
@amy-lei @dbieber
You can’t perform that action at this time.