ipython / ipython/traitlets

`TraitType.make_dynamic_default` is not mentioned in the docs

Open
#787 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
653
Forks
217
Avg merge
2d 21h
Merged PRs (30d)
2

Description

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.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.