google / google/python-fire

Feature Request - Improved Documentation With Help Output

オープン
#276 コメント 1 件 リアクション 4 件 担当者 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 を短くまとめたダイジェスト。