ipython / ipython/traitlets

`TraitType.make_dynamic_default` is not mentioned in the docs

Aperta
#787 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
Lingua principale
Python
Stelle
653
Fork
217
Merge medio
2g 21h
PR unite (30g)
2

Descrizione

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.

Guida per i contributori

Apri la guida per i contributori

Valutazione

Questa issue non è ancora stata valutata.

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.