google / google/python-fire

Feature Request - Improved Documentation With Help Output

未关闭
#276 1 条评论 4 个 reaction 已指派 0 人 在 GitHub 查看
主要语言
Python
星标
28.2k
派生
1.5k
PR 合并指标
30 天内没有已合并 PR

描述

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.

贡献指南

打开贡献指南

评估

这个 Issue 还没有评估数据。

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。