google / google/python-fire

Feature Request - Improved Documentation With Help Output

Aberta
#276 1 comentário 4 reações 0 responsáveis Ver no GitHub
Linguagem predominante
Python
Estrelas
28.2k
Forks
1.5k
Métricas de merge de PRs
Nenhum PR com merge em 30d

Descrição

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.

Guia de contribuição

Abrir o guia de contribuição

Avaliação

Esta issue ainda não foi avaliada.

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.