ipython / ipython/traitlets

help= does not set trait docstring

Open
#461 6 comments 1 reaction 0 assignees View on GitHub
enhancement good first issue sprint-friendly
Dominant language
Python
Stars
653
Forks
217
Avg merge
2d 21h
Merged PRs (30d)
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?

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.