ipython / ipython/traitlets

docs: document `log` trait on `Application` class

Ouverte Adaptée aux débutants
#755 0 commentaires 1 réaction 0 personnes assignées Voir sur GitHub
Langage dominant
Python
Étoiles
653
Forks
217
Merge moyen
2 j 21 h
PR mergées (30 j)
2

Description

The docs for the [Application](https://traitlets.readthedocs.io/en/latest/config-api.html#traitlets.config.Application) class don't mention the default value of the `log` trait on `Application` to be a `Logger` instance named with `self.__class__.__name__`. I had to dig through the code to find [the line where this default is set](https://github.com/ipython/traitlets/blob/main/traitlets/config/application.py#L286). Can we update the documentation here accordingly?

Guide de contribution

Ouvrir le guide de contribution

Piste de recherche

Start with the Application class documentation at the linked config-api page and inspect traitlets/config/application.py around line 286, where the default is set. Update the documentation to state that the log trait defaults to a Logger named with self.__class__.__name__, then check the rendered documentation for the new detail.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
python
Domaine
documentation
Type d'issue
Documentation
Difficulté
1/5
Temps estimé
Moins d'une heure
Activité
À l'abandon
Clarté
Clairement spécifiée
Accessibilité débutants
65/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.