DiamondLightSource / DiamondLightSource/python-copier-template
Support linting docstrings
未關閉
- 主要語言
- Jinja
- 星號
- 25
- 分支
- 10
- 平均合併
- 4 小時 4 分鐘
- 30 天內合併 PR
- 6
描述
https://github.com/jsh9/pydoclint , https://github.com/akaihola/darglint2 and others lint docstrings to ensure they are congruent with the function/class/method that they are documenting. This could be a useful sanity check
貢獻指南
研究方向
未指定檔案或測試。先檢查 template 如何設定 Python linting 和相依套件,然後比較 pydoclint 與 darglint2 是否與該設定相容。完成條件應包括決定使用的工具、整合設定,以及驗證 docstring 一致性檢查能如預期執行。
由索引模型根據 Issue 內容生成。
評估
- 技術堆疊
- python
- 領域
- tooling
- Issue 類型
- 功能
- 難度
- 4/5
- 預估耗時
- 3-5 天
- 活躍度
- 停滯
- 描述清晰度
- 需要釐清
- 新手友好度
- 38/100