Add docstrings to all public methods
还没有人认领这个 Issue。
评估
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 新手友好度
- 35/100
- Issue 类型
- 文档
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- python
- 领域
- api, documentation
调研方向
从 api.MatrixHttpApi 中的 get_display_name 开始，然后盘点 SDK 的其他公共方法，并检查它们现有的调用方。完成的标准是：每个公共方法都有 docstring；被判定为私有的方法通过带有警告的已弃用公共包装器进行委托，而 SDK 内部调用使用私有名称。
由索引模型根据 Issue 内容生成。
描述
For instance, get_display_name in api.MatrixHttpApi needs a docstring. Many others as well.
In doing this, you may run across methods that it seems should be private rather than public; in that case, please go ahead and make method call _method while raising a deprecation warning and point all code within the sdk towards _method
- 主要语言
- Python
- 星标
- 266
- 派生
- 118
- PR 合并指标
- 30 天内没有已合并 PR
贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
matrix-org/matrix-python-sdk 的其他 Issue
-
难度 1/5 1 小时以内 新手友好度 25/100
matrix-org/matrix-python-sdk#330 · 3 个 reaction ·
-
难度 5/5 一周以上 新手友好度 25/100
matrix-org/matrix-python-sdk#326 ·
-
难度 1/5 1 小时以内 新手友好度 55/100
matrix-org/matrix-python-sdk#324 ·
-
难度 2/5 1-3 小时 新手友好度 48/100
matrix-org/matrix-python-sdk#323 ·
-
难度 3/5 1-2 天 新手友好度 35/100
matrix-org/matrix-python-sdk#319 ·
查看 matrix-org/matrix-python-sdk 的全部 Issue
相似的 Issue
-
area: harness bug status: needs-triage
难度 2/5 1-3 小时 新手友好度 75/100
Human-Agent-Society/reef#625 ·
-
难度 2/5 1-3 小时 新手友好度 70/100
-
难度 1/5 1 小时以内 新手友好度 80/100
learningequality/kolibri#15351 · 2 条评论 ·
-
难度 2/5 1-3 小时 新手友好度 75/100
-
Name consistency 未关闭
难度 2/5 1-3 小时 新手友好度 75/100
eellak/triplestore#65 · 1 条评论 ·