google / google/python-fire

Feature Request - Improved Documentation With Help Output

Open
#276 1 comment 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

I'm not finding an easy way to get the --help output to include some basic information including details about the arguments. It seems to just parse the function signature and reflects on that only. Maybe I'm just not assembling the function's documentation correctly. Either way I found little to no examples in the online documentation explaining how --help is can be used in this way as well as no existing examples in the source code's examples directory showing this. I'm not sure if this is possible, but it would be nice to know how to improve the --help output so its not missing details.

[Here's an example](https://gist.github.com/Sn3akyP3t3/f571c4baf272db191ed59f03359795c0) that I put together with a function description and information for the args as to how they should display with --help output.

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.