ipython / ipython/traitlets

help= does not set trait docstring

オープン
#461 コメント 6 件 リアクション 1 件 担当者 0 名 GitHub で見る
enhancement good first issue sprint-friendly
主要言語
Python
スター
653
フォーク
217
平均マージ
2日 21時間
マージ済み PR(30日)
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 を短くまとめたダイジェスト。