explicit list exported traits with `__all__`
未关闭
- 主要语言
- Python
- 星标
- 653
- 派生
- 217
- 平均合并
- 2 天 21 小时
- 30 天内合并 PR
- 2
描述
We should define `__all__` in traitlets/traitlets.py, so that it's explicit what's exported as public API.
There are a few utility functions and classes such as DefaultHandler that are accidentally exposed (undocumented, so nobody has any reasonable expectation of using them). We should take the opportunity of a 5.0 release to explicitely list the actual traitlets API.
贡献指南
调研方向
Start by reading traitlets/traitlets.py and inventorying its public classes and functions against the documented traitlets API, including the accidentally exposed DefaultHandler. Done means the module defines an explicit __all__ containing the intended public API while leaving undocumented utilities unlisted.
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- python
- 领域
- api
- Issue 类型
- 功能
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 30/100