`TraitType.make_dynamic_default` is not mentioned in the docs
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 1/5
- Temps estimé
- 1-3 heures
- Accessibilité débutants
- 55/100
- Type d'issue
- Documentation
- Clarté
- Clairement spécifiée
- Activité
- À l'abandon
- Stack technique
- python
- Domaine
- documentation
Piste de recherche
Commencez par la page de documentation defining_traits liée et examinez l’exemple de TraitTypes personnalisés ainsi que l’implémentation de make_dynamic_default mentionnée dans traitlets/traitlets.py. Mettez à jour la documentation publique pour expliquer les valeurs par défaut mutables sûres pour les TraitTypes personnalisés, y compris la méthode concernée, et vérifiez que l’exemple et l’explication sont exacts.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
Per the title, there is no mention of make_dynamic_default for custom TraitTypes in the docs right now. 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, but this should be better highlighted in the public-facing documentation.
- Langage dominant
- Python
- Étoiles
- 653
- Forks
- 221
- Métriques de merge des PR
- Aucune PR mergée en 30 j
Préparer son environnement
- Aucun Dockerfile ni fichier Docker Compose
- Aucun modèle de pull request
- Lire le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de ipython/traitlets
-
Difficulté 1/5 Moins d'une heure Accessibilité débutants 65/100
-
Difficulté 1/5 1-3 heures Accessibilité débutants 65/100
-
Add Deprecation of Trait Declarations via Classes to Migration NotesPeut-être à nouveau libre Une pull request pour cette issue a été fermée sans être fusionnée. Ouvertegood first issue
Difficulté 1/5 Moins d'une heure Accessibilité débutants 85/100
-
Document `TraitType.read_only`Ouvertedocumentation
Difficulté 1/5 Moins d'une heure Accessibilité débutants 65/100
-
traitlets.Set should support generic type annotations for type safetyPeut-être pris @GruffElixir l’a pris il y a 33 jours. Ouverte
Difficulté 3/5 1-2 jours Accessibilité débutants 45/100
Toutes les issues de ipython/traitlets
Issues similaires
-
Difficulté 2/5 1-3 heures Accessibilité débutants 74/100
vllm-project/vllm#61131 ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100
kubernetes-client/python#2735 ·
Les mainteneurs répondent en général sous 1 jour
-
desktop help wanted test
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100
Les mainteneurs répondent en général sous 1 jour
-
Broken links found in docsOuvertedocs pydanty:is-working
Difficulté 2/5 1-3 heures Accessibilité débutants 68/100
pydantic/pydantic-ai#10113 ·
Les mainteneurs répondent en général sous 1 jour
-
Tutorial unit test leaks sample data into tutorial doctestPeut-être pris @Gambit-Checkmate l’a pris aujourd’hui. Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 84/100