ipython / ipython/traitlets

help= does not set trait docstring

Đang mở
#461 6 bình luận 1 reaction 0 người được giao Xem trên GitHub
enhancement good first issue sprint-friendly
Ngôn ngữ chính
Python
Star
653
Fork
217
Merge trung bình
2 ngày 21 giờ
Pull request đã merge (30 ngày)
2

Mô tả

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?

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Đánh giá

Issue này chưa được đánh giá.

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.