ipython / ipython/traitlets

help= does not set trait docstring

未关闭
#461 6 条评论 1 个 reaction 已指派 0 人 在 GitHub 查看
enhancement good first issue sprint-friendly
主要语言
Python
星标
653
派生
217
平均合并
2 天 21 小时
30 天内合并 PR
2

描述

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?

贡献指南

打开贡献指南

评估

这个 Issue 还没有评估数据。

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。