Explicitly define public API with `__all__`
還沒有人認領這個 Issue。
評估
研究方向
首先檢視 cf-python 套件的模組和 docs/source/check_docs_api_coverage.py，以了解哪些名稱會被視為公開名稱，以及如何檢查 API 覆蓋率。在整個程式碼庫中一致地定義預期的公開名稱，接著確認文件覆蓋率指令碼可以將這些宣告作為規範來源。
由索引模型根據 Issue 內容生成。
描述
We don't define the __all__ variable across the cf-python codebase, however we should because doing so has a number of benefits - through providing a single machine-readable source of truth for the API.
One, which I'll note (alone, otherwise see link above to benefits) because it relates to what I'm working on with #957 fixes, is to allow us to know canonically what should be present in the documentation, for example for our API coverage check script to use.
I'm labelling this also with 'API review (4.0.0)' because it can allow us to see more clearly the public API we have, facilitating review of it.
- 主要語言
- Python
- 星號
- 151
- 分支
- 23
- 平均合併
- 1 天 2 小時
- 30 天內合併 PR
- 1
環境準備
- 沒有 Dockerfile 或 Docker Compose 檔案
- 沒有 Pull Request 範本
- 閱讀貢獻指南
從這裡開始
- 先讀完整個 Issue，再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫，在一個分支上完成修改。
- 送出 Pull Request，並在描述裡引用這個 Issue 編號。
NCAS-CMS/cf-python 的其他 Issue
-
installation
難度 4/5 3-5 天 新手友好度 45/100
-
Attempt at unsupported conservative 3D mesh regridding可能重新可做 @sadielbartholomew 於 53 天前認領，目前沒有進行中的 PR。 未關閉bug?
-
bug
難度 3/5 1-2 天 新手友好度 45/100
-
enhancement xarray
難度 4/5 3-5 天 新手友好度 48/100
-
bug?
難度 3/5 1-2 天 新手友好度 55/100
查看 NCAS-CMS/cf-python 的全部 Issue
相似的 Issue
-
Import errors are swallowed: PerthImplicitWatermarker silently becomes None可能已有人在做 @JonRC 今天認領。 未關閉
難度 2/5 1-3 小時 新手友好度 82/100
resemble-ai/Perth#23 ·
-
correction metadata
難度 2/5 1 小時以內 新手友好度 65/100
acl-org/acl-anthology#10753 · 1 則留言 ·
維護者通常 1 天內回覆
-
難度 2/5 1-3 小時 新手友好度 62/100
earthtojake/text-to-cad#758 ·
維護者通常 1 天內回覆
-
難度 1/5 1-3 小時 新手友好度 70/100
DataTalksClub/faq#545 ·
維護者通常 2 天內回覆
-
難度 2/5 1-3 小時 新手友好度 62/100
維護者通常 1 天內回覆