ipython / ipython/traitlets

`TraitType.make_dynamic_default` is not mentioned in the docs

Đang mở
#787 0 bình luận 0 reaction 0 người được giao Xem trên GitHub
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ả

Per the title, there is no mention of `make_dynamic_default` for custom `TraitTypes` in the [docs right now](https://traitlets.readthedocs.io/en/stable/defining_traits.html). The current example uses a tuple with two immutable elements, so it's technically safe, but it is at best incomplete (for people who want a mutable default) and at worst misleading (for people who thoughtlessly use a list or other mutable type instead of tuple, or put something mutable inside such a tuple).

The code itself is very nicely written, so once I decided it *ought* to be possible to safely have mutable defaults for children of `TraitTypes` I had no trouble finding [the search for `make_dynamic_default`](https://github.com/ipython/traitlets/blob/c17eb89e8201e06791e5439585d34d05c28aefff/traitlets/traitlets.py#L616), but this should be better highlighted in the public-facing documentation.

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.