docstrings are inconsistent making Sphinx documentation not display properly
還沒有人認領這個 Issue。
評估
- 難度
- 3/5
- 預估耗時
- 1-2 天
- 新手友好度
- 45/100
- Issue 類型
- 文件
- 描述清晰度
- 基本清楚
- 活躍度
- 停滯
- 技術堆疊
- python
研究方向
首先比較 azure-devops/azure/devops/v7_0/build/build_client.py（約第 14–18 行）中的 docstring 與 azure-devops/azure/devops/v7_0/build/models.py（約第 12–26 行）中的 docstring。建置 Sphinx 文件以識別格式錯誤，然後檢查受影響模組的 docstring，並確認文件可以成功編譯。
由索引模型根據 Issue 內容生成。
描述
Related to Issue: https://github.com/microsoft/azure-devops-python-api/issues/349
When using Sphinx to build documentation for this Python module, it appears that there are some modules that do not have appropriate spacing between the summary and the parameters docstrings causing Sphinx to not compile properly.
Some of the docstrings do not have spaces like:
But the functional lines that display properly have space around the description, like:
- 主要語言
- Python
- 星號
- 684
- 分支
- 218
- PR 合併指標
- 30 天內沒有已合併 PR
環境準備
我們還沒有檢查這個專案的環境設定檔。先看它的 README，通用步驟見我們的新手貢獻指南。
從這裡開始
- 先讀完整個 Issue，再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫，在一個分支上完成修改。
- 送出 Pull Request，並在描述裡引用這個 Issue 編號。
microsoft/azure-devops-python-api 的其他 Issue
-
難度 2/5 1-3 小時 新手友好度 55/100
-
難度 5/5 一週以上 新手友好度 25/100
-
難度 1/5 1 小時以內 新手友好度 55/100
-
難度 4/5 3-5 天 新手友好度 35/100
-
難度 3/5 1-2 天 新手友好度 45/100
查看 microsoft/azure-devops-python-api 的全部 Issue
相似的 Issue
-
難度 2/5 1-3 小時 新手友好度 78/100
solana-foundation/pay-kit#341 ·
維護者通常 1 天內回覆
-
難度 2/5 1-3 小時 新手友好度 78/100
nasa/python_cmr#123 ·
-
難度 1/5 1 小時以內 新手友好度 92/100
EleutherAI/lm-evaluation-harness#4243 ·
維護者通常 1 天內回覆
-
area: dashboard bug perceived difficulty: 3
難度 2/5 1-3 小時 新手友好度 88/100
Nitjsefnie-Harness-Commons/daedalus#1179 ·
維護者通常 1 天內回覆
-
難度 2/5 1-3 小時 新手友好度 88/100
cusp-ai-oss/tojax#17 ·