ipython / ipython/traitlets

help= does not set trait docstring

Ouverte
#461 6 commentaires 1 réaction 0 personnes assignées Voir sur GitHub
enhancement good first issue sprint-friendly
Langage dominant
Python
Étoiles
653
Forks
217
Merge moyen
2 j 21 h
PR mergées (30 j)
2

Description

At the moment, it looks like the ``help=`` text doesn't set the ``__doc__`` attribute of traits, which produces this kind of output when using sphinx's autosummary:

![screen shot 2017-12-04 at 15 01 23](https://user-images.githubusercontent.com/314716/33559237-104eaea4-d904-11e7-897c-3ffcf767c105.png)

Would it be possible to use the help text to also set ``__doc__`` on traits or is there a good reason why this isn't done?

Guide de contribution

Ouvrir le guide de contribution

Évaluation

Cette issue n'a pas encore été évaluée.

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.