Skip to content

Issue 259: Add 🔑 parameters to help string #275

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
Closed
amy-lei wants to merge 3 commits into from
Closed

Issue 259: Add 🔑 parameters to help string #275

amy-lei wants to merge 3 commits into from

Conversation

@amy-lei
Copy link
Contributor

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

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.

@google-cla google-cla bot added the cla: yes Author has signed CLA label Jul 27, 2020
@amy-lei amy-lei marked this pull request as ready for review August 3, 2020 20:22
@dbieber
Copy link
Collaborator

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.
🙏

python-fire-bot pushed a commit that referenced this pull request Dec 16, 2020
@amy-lei @copybara-github
Add :key type name: parameters to help text
aa18534 
a22cb7d by Amy <leiamy12@gmail.com>
26aba55 by Amy <leiamy12@gmail.com>
9bcccf9 by Amy <leiamy12@gmail.com>

COPYBARA_INTEGRATE_REVIEW=#275 from amy-lei:key-param 9bcccf9
PiperOrigin-RevId: 347874060
Change-Id: Id7d59472a73bf1fa33d37334e7e72702a07c72f6
@dbieber
Copy link
Collaborator

dbieber commented Dec 16, 2020

Merged with aa18534

Thanks for the contribution!

@dbieber dbieber closed this Dec 16, 2020
@dbieber dbieber mentioned this pull request Dec 16, 2020
Closed
CherylMoonba added a commit to CherylMoonba/devices that referenced this pull request Jul 20, 2025
@CherylMoonba
Add :key type name: parameters to help text
9c542fe 
a22cb7dd08c49357cdc5bf62d59d6c650fb9548b by Amy <leiamy12@gmail.com>
26aba559cef2ad07ea0516e92db029ee04956a16 by Amy <leiamy12@gmail.com>
9bcccf992b15d1eebb05a3e2267bc6228269dd90 by Amy <leiamy12@gmail.com>

COPYBARA_INTEGRATE_REVIEW=google/python-fire#275 from amy-lei:key-param 9bcccf992b15d1eebb05a3e2267bc6228269dd90
PiperOrigin-RevId: 347874060
Change-Id: Id7d59472a73bf1fa33d37334e7e72702a07c72f6
KurtMuelle added a commit to KurtMuelle/obtained that referenced this pull request Jul 22, 2025
@KurtMuelle
Add :key type name: parameters to help text
3feb1c2 
a22cb7dd08c49357cdc5bf62d59d6c650fb9548b by Amy <leiamy12@gmail.com>
26aba559cef2ad07ea0516e92db029ee04956a16 by Amy <leiamy12@gmail.com>
9bcccf992b15d1eebb05a3e2267bc6228269dd90 by Amy <leiamy12@gmail.com>

COPYBARA_INTEGRATE_REVIEW=google/python-fire#275 from amy-lei:key-param 9bcccf992b15d1eebb05a3e2267bc6228269dd90
PiperOrigin-RevId: 347874060
Change-Id: Id7d59472a73bf1fa33d37334e7e72702a07c72f6
hwlegends pushed a commit to hwlegends/python-fire that referenced this pull request Aug 20, 2025
@amy-lei @copybara-github
Add :key type name: parameters to help text
4744e83 
a22cb7dd08c49357cdc5bf62d59d6c650fb9548b by Amy <leiamy12@gmail.com>
26aba559cef2ad07ea0516e92db029ee04956a16 by Amy <leiamy12@gmail.com>
9bcccf992b15d1eebb05a3e2267bc6228269dd90 by Amy <leiamy12@gmail.com>

COPYBARA_INTEGRATE_REVIEW=google/python-fire#275 from amy-lei:key-param 9bcccf992b15d1eebb05a3e2267bc6228269dd90
PiperOrigin-RevId: 347874060
Change-Id: Id7d59472a73bf1fa33d37334e7e72702a07c72f6
marsMerge2021 added a commit to marsMerge2021/NTPMeasures that referenced this pull request Aug 31, 2025
@marsMerge2021
Add :key type name: parameters to help text
efc32ae 
a22cb7dd08c49357cdc5bf62d59d6c650fb9548b by Amy <leiamy12@gmail.com>
26aba559cef2ad07ea0516e92db029ee04956a16 by Amy <leiamy12@gmail.com>
9bcccf992b15d1eebb05a3e2267bc6228269dd90 by Amy <leiamy12@gmail.com>

COPYBARA_INTEGRATE_REVIEW=google/python-fire#275 from amy-lei:key-param 9bcccf992b15d1eebb05a3e2267bc6228269dd90
PiperOrigin-RevId: 347874060
Change-Id: Id7d59472a73bf1fa33d37334e7e72702a07c72f6
Hernandez19891 added a commit to Hernandez19891/Illumina that referenced this pull request Sep 15, 2025
@Hernandez19891
Add :key type name: parameters to help text
8b9f89a 
a22cb7dd08c49357cdc5bf62d59d6c650fb9548b by Amy <leiamy12@gmail.com>
26aba559cef2ad07ea0516e92db029ee04956a16 by Amy <leiamy12@gmail.com>
9bcccf992b15d1eebb05a3e2267bc6228269dd90 by Amy <leiamy12@gmail.com>

COPYBARA_INTEGRATE_REVIEW=google/python-fire#275 from amy-lei:key-param 9bcccf992b15d1eebb05a3e2267bc6228269dd90
PiperOrigin-RevId: 347874060
Change-Id: Id7d59472a73bf1fa33d37334e7e72702a07c72f6
1278827 added a commit to 1278827/Hardware that referenced this pull request Sep 23, 2025
@1278827
Add :key type name: parameters to help text
3ad1298 
a22cb7dd08c49357cdc5bf62d59d6c650fb9548b by Amy <leiamy12@gmail.com>
26aba559cef2ad07ea0516e92db029ee04956a16 by Amy <leiamy12@gmail.com>
9bcccf992b15d1eebb05a3e2267bc6228269dd90 by Amy <leiamy12@gmail.com>

COPYBARA_INTEGRATE_REVIEW=google/python-fire#275 from amy-lei:key-param 9bcccf992b15d1eebb05a3e2267bc6228269dd90
PiperOrigin-RevId: 347874060
Change-Id: Id7d59472a73bf1fa33d37334e7e72702a07c72f6
VLLanguage added a commit to VLLanguage/VLLanguage that referenced this pull request Nov 23, 2025
@VLLanguage
Add :key type name: parameters to help text
02d9cbf 
a22cb7dd08c49357cdc5bf62d59d6c650fb9548b by Amy <leiamy12@gmail.com>
26aba559cef2ad07ea0516e92db029ee04956a16 by Amy <leiamy12@gmail.com>
9bcccf992b15d1eebb05a3e2267bc6228269dd90 by Amy <leiamy12@gmail.com>

COPYBARA_INTEGRATE_REVIEW=google/python-fire#275 from amy-lei:key-param 9bcccf992b15d1eebb05a3e2267bc6228269dd90
PiperOrigin-RevId: 347874060
Change-Id: Id7d59472a73bf1fa33d37334e7e72702a07c72f6
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 Author has signed CLA

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

🔑 parameter documentation doesn't correctly display in help signature

2 participants

@amy-lei @dbieber