ipython / ipython/traitlets

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

未关闭 适合新手
#755 0 条评论 1 个 reaction 已指派 0 人 在 GitHub 查看
主要语言
Python
星标
653
派生
217
平均合并
2 天 21 小时
30 天内合并 PR
2

描述

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?

贡献指南

打开贡献指南

调研方向

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.

由索引模型根据 Issue 内容生成。

评估

技术栈
python
领域
documentation
Issue 类型
文档
难度
1/5
预计耗时
1 小时以内
活跃度
停滞
描述清晰度
描述清楚
新手友好度
65/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。