Improve API doc for users
维护者通常 3 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 新手友好度
- 35/100
- Issue 类型
- 文档
- 描述清晰度
- 需要澄清
- 活跃度
- 停滞
- 技术栈
- python
调研方向
首先查看发布的 API 文档：https://appium.github.io/python-client-sphinx/，然后将其与 issue 中列出的 Sphinx 示例和 Napoleon Config 参考进行比较。确定具体的面向用户的缺口并更新文档；完成的标准是 API 参考更易于用户使用。
由索引模型根据 Issue 内容生成。
描述
The problem
Just published API doc.
https://appium.github.io/python-client-sphinx/
However, it is just first revision and could be more user friendly.
References
- 主要语言
- Python
- 星标
- 1.8k
- 派生
- 570
- 平均合并
- 1 天 10 小时
- 30 天内合并 PR
- 24
环境准备
我们还没有检查这个项目的环境配置文件。先看它的 README，通用步骤见我们的新手贡献指南。
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
appium/python-client 的其他 Issue
-
难度 5/5 一周以上 新手友好度 25/100
appium/python-client#1230 · 1 条评论 ·
维护者通常 3 天内回复
-
question
难度 4/5 3-5 天 新手友好度 25/100
appium/python-client#1168 · 9 条评论 ·
维护者通常 3 天内回复
-
难度 2/5 1-3 小时 新手友好度 55/100
appium/python-client#1147 · 7 条评论 ·
维护者通常 3 天内回复
-
难度 3/5 1-2 天 新手友好度 38/100
appium/python-client#1091 · 4 条评论 ·
维护者通常 3 天内回复
-
难度 4/5 3-5 天 新手友好度 25/100
appium/python-client#1076 · 2 条评论 ·
维护者通常 3 天内回复
查看 appium/python-client 的全部 Issue
相似的 Issue
-
good first issue
难度 2/5 1-3 小时 新手友好度 88/100
-
难度 2/5 1-3 小时 新手友好度 88/100
vllm-project/vllm-metal#822 ·
维护者通常 1 天内回复
-
vector-store
难度 1/5 1-3 小时 新手友好度 90/100
维护者通常 1 天内回复
-
[Bug]: chunk_span_bounds and _validated_chunk_spans reject Pydantic models ChunkSpan and AudioFile未关闭
难度 2/5 1-3 小时 新手友好度 78/100
BasedHardware/omi#19047 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 88/100
维护者通常 1 天内回复