Better magic_underscore explanation in docstrings
Aberta
@nicholas-esterer já está trabalhando nisso.
Desde 13/10/2020.
documentation
feature
P3
- Linguagem predominante
- Python
- Estrelas
- 18.8k
- Forks
- 2.8k
- Merge médio
- 16h 26min
- PRs com merge (30d)
- 21
Descrição
I'd love to have a better answer for this kind of thing: https://stackoverflow.com/questions/58990657/python-how-do-i-find-inspect-what-kind-of-arguments-a-function-accepts
Some thoughts:
- The constructors of all the
graph_objectsthat accept**kwargsshould include an entry for this in the docstring. - Wherever we accept another graph_object (e.g.
markeringo.Scatter) the docstring could mention that you can also tomarker_whatever? - Wherever we accept
**kwargs, the docstring for that item should contain some self-contained explanation of what magic-underscores are and a link to the relevant docs. Minimally something like "for any other arguementxin this function which accepts agraph_object, you may usex_ywhereyis a valid property of the correspondinggraph_object." - For generic methods like update/add etc we should mention the name of the relevant graph_object whose properties are accepted, so that they show up in the Sphinx doc and provide a trail that users can follow. E.g. in https://plot.ly/python-api-reference/generated/plotly.graph_objects.Figure.html#plotly.graph_objects.Figure.update_xaxes we should mention in
patchandkwargsthat the relevant attributes are to be found inplotly.graph_objects.layout.Xaxisetc.
@emmanuelle thoughts?
Guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Avaliação
Esta issue ainda não foi avaliada.