Improve in-code documentation
@owensun2004 已經在處理了。
開始於 2023年11月4日。
評估
- 難度
- 5/5
- 預估耗時
- 一週以上
- 新手友好度
- 20/100
- Issue 類型
- 文件
- 描述清晰度
- 需要釐清
- 活躍度
- 停滯
- 技術堆疊
- python
研究方向
首先調查 Python 程式碼庫，找出缺少的 pydocs，並審查 issue 中提到的提議 PRs。範圍涵蓋幾乎所有程式碼中的文件與範例，以及一項用於防止 PRs 缺少文件的政策。要完成這項工作，需要達成共識的方法，並廣泛涵蓋缺少的文件。
由索引模型根據 Issue 內容生成。
描述
Almost all code now lacks proper pydocs across almost all the codebase. We should consider the following PRs are gonna improve the situation.
It should be prohibited to merge PRs that do not have docs. We should eventually cover all the missing places with appropriate documentation and examples.
- 主要語言
- Python
- 星號
- 343
- 分支
- 65
- PR 合併指標
- 30 天內沒有已合併 PR
環境準備
- 沒有 Dockerfile 或 Docker Compose 檔案
- 有 Pull Request 範本
- 閱讀貢獻指南
從這裡開始
- 先讀完整個 Issue，再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫，在一個分支上完成修改。
- 送出 Pull Request，並在描述裡引用這個 Issue 編號。
cloudevents/sdk-python 的其他 Issue
-
Kafka `to_binary()` crashes on events without `datacontenttype` or with non-string attributes可能已有人在做 關聯的 PR 仍在進行中或已合併。 未關閉
難度 2/5 1-3 小時 新手友好度 78/100
cloudevents/sdk-python#304 ·
-
CloudEvent serializes invalid extension attribute names without validation可能已有人在做 @MickeyWzt 於 95 天前認領。 未關閉bug
難度 2/5 1-3 小時 新手友好度 68/100
cloudevents/sdk-python#300 ·
-
enhancement
難度 2/5 1-3 小時 新手友好度 68/100
cloudevents/sdk-python#291 · 8 則留言 ·
-
Improve the docstring of abstract.CloudEvent可能已有人在做 @manduinca 於 78 天前認領。 未關閉
難度 1/5 1 小時以內 新手友好度 48/100
cloudevents/sdk-python#247 · 2 則留言 ·
-
question
難度 3/5 1-2 天 新手友好度 45/100
cloudevents/sdk-python#246 · 5 則留言 ·
查看 cloudevents/sdk-python 的全部 Issue
相似的 Issue
-
難度 1/5 1 小時以內 新手友好度 85/100
-
難度 1/5 1 小時以內 新手友好度 75/100
-
難度 1/5 1 小時以內 新手友好度 85/100
-
難度 1/5 1 小時以內 新手友好度 85/100
data-umbrella/du-event-board#225 ·
-
難度 2/5 1-3 小時 新手友好度 75/100