google / google/python-fire

[help] Display custom docstring from functions

Open
#305 0 comments 4 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
28.2k
Forks
1.5k
PR merge metrics
No merged PRs in 30d

Description

Hi. There's a way to use my doc string when running from command line?
This is the default behavior:
```
ERROR: The function received no value for the required argument: uuid
Usage: hc-fail UUID
optional flags: --log | --wait

For detailed information on this command, run:
hc-fail --help
```
I wanna see my doc string help, not the Fire one. This is possible?
i.e.
```
Make a health check fail right away
Parameters
----------
uuid :
uuid from the health check task.
log :
Create a custom log message.
```

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.