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 天內回覆