docs: Include the relevant securesystemslib classes in docs
維護者通常 1 天內回覆
還沒有人認領這個 Issue。
評估
- 難度
- 2/5
- 預估耗時
- 1-3 小時
- 新手友好度
- 35/100
- Issue 類型
- 文件
- 描述清晰度
- 基本清楚
- 活躍度
- 停滯
- 技術堆疊
- python
研究方向
首先檢視現有的 python-tuf API 文件，以及其中的 autodoc 指示詞如何組織。判斷在其中加入 securesystemslib.signer.Signature 與相關類別，是否能在不記錄無關的 securesystemslib API 的情況下滿足 Metadata API 目標。相關類別透過聚焦且已達成共識的方法完成文件化或連結後，即視為完成。
由索引模型根據 Issue 內容生成。
描述
Signer, Signature (and in future maybe most of Key) are really part of the Metadata API but are technically implemented in securesystemslib.
We should either include those in the python-tuf API docs, or create similar docs for securesystemslib and link to those (but we don't want to document the rest of securesystemslib API in the same manner).
The former (including in python-tuf api docs) might be quite simple as plain:
.. autoclass:: securesystemslib.signer.Signature
seems to get us most of the way there...
- 主要語言
- Python
- 星號
- 1.7k
- 分支
- 304
- 平均合併
- 9 小時 25 分鐘
- 30 天內合併 PR
- 14
環境準備
- 沒有 Dockerfile 或 Docker Compose 檔案
- 有 Pull Request 範本
- 閱讀貢獻指南
從這裡開始
- 先讀完整個 Issue，再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫，在一個分支上完成修改。
- 送出 Pull Request，並在描述裡引用這個 Issue 編號。
theupdateframework/python-tuf 的其他 Issue
-
難度 4/5 3-5 天 新手友好度 48/100
theupdateframework/python-tuf#3001 ·
維護者通常 1 天內回覆
-
難度 4/5 3-5 天 新手友好度 42/100
theupdateframework/python-tuf#2979 · 1 則留言 ·
維護者通常 1 天內回覆
-
enhancement github_actions
難度 3/5 1-2 天 新手友好度 45/100
theupdateframework/python-tuf#2920 · 1 則留言 · 2 個 reaction ·
維護者通常 1 天內回覆
-
難度 3/5 1-2 天 新手友好度 35/100
theupdateframework/python-tuf#2842 · 3 則留言 ·
維護者通常 1 天內回覆
-
難度 5/5 一週以上 新手友好度 25/100
theupdateframework/python-tuf#2836 · 7 則留言 ·
維護者通常 1 天內回覆
查看 theupdateframework/python-tuf 的全部 Issue
相似的 Issue
-
難度 2/5 1-3 小時 新手友好度 86/100
維護者通常 1 天內回覆
-
難度 2/5 1-2 天 新手友好度 70/100
-
難度 2/5 1-3 小時 新手友好度 88/100
維護者通常 7 天內回覆
-
難度 2/5 1-3 小時 新手友好度 70/100
lmstudio-ai/mlx-engine#376 ·
-
難度 2/5 1-3 小時 新手友好度 72/100
pyiron/bagofholding#166 ·