Consider using computed docstrings
維護者通常 1 天內回覆
還沒有人認領這個 Issue。
評估
- 難度
- 4/5
- 預估耗時
- 3-5 天
- 新手友好度
- 18/100
- Issue 類型
- 重構
- 描述清晰度
- 基本清楚
- 活躍度
- 停滯
- 技術堆疊
- python
研究方向
The duplicated text lives in the new pvlib.iotools.psm4 functions, so start by comparing their docstrings to see which parts are shared. The thread leaves open whether docstrings are built at import time or at package build, and that choice is a design decision for maintainers. Done would mean one agreed approach, applied to psm4 with rendered docs and tests unchanged.
由索引模型根據 Issue 內容生成。
描述
As mentioned by @wholmgren in https://github.com/pvlib/pvlib-python/issues/2326#issuecomment-2685685954, the new pvlib.iotools.psm4 functions have long, very similar docstrings, which may be improved by using computed docstrings:
If we go with the separate functions then I think we should venture into computed docstrings. Computed docstrings are now common in the pydata world but haven't yet been used in pvlib. The module is 800 lines and about half of those are minor permutations of a 100 line docstring - and this will only get worse if we mirror more of the NSRDB API.
Here are some breadcrumbs I found with a brief investigation:
- Some PyPI packages exist for this sort of thing: https://pypi.org/search/?q=docstring
- pandas uses this: https://github.com/pandas-dev/pandas/blob/main/pandas/util/_decorators.py#L342
- scipy uses this: https://github.com/scipy/scipy/blob/main/scipy/_lib/doccer.py
- but not everyone likes it: https://github.com/scientific-python/summit-2024/issues/27
Some additional food for thought: do the docstrings have to be generated at import time (may not work with some IDEs as linked above, plus adds import overhead), or can we find some way to generate them once during package build or installation?
- 主要語言
- Python
- 星號
- 1.7k
- 分支
- 1.2k
- 平均合併
- 3 天 18 小時
- 30 天內合併 PR
- 13
環境準備
- 沒有 Dockerfile 或 Docker Compose 檔案
- 有 Pull Request 範本
- 閱讀貢獻指南
從這裡開始
- 先讀完整個 Issue，再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫，在一個分支上完成修改。
- 送出 Pull Request，並在描述裡引用這個 Issue 編號。
pvlib/pvlib-python 的其他 Issue
-
bug
難度 2/5 1-3 小時 新手友好度 78/100
pvlib/pvlib-python#2903 · 5 則留言 · 2 個 reaction ·
維護者通常 1 天內回覆
-
難度 1/5 1 小時以內 新手友好度 92/100
pvlib/pvlib-python#2902 ·
維護者通常 1 天內回覆
-
Add an example or documentation on using 'bhi' from ERA5可能重新可做 @anshurajbisoyi98-ctrl 於 14 天前認領，目前沒有進行中的 PR。 未關閉
難度 2/5 1-3 小時 新手友好度 66/100
pvlib/pvlib-python#2880 · 2 則留言 ·
維護者通常 1 天內回覆
-
Use "long-wave" rather than "infra-red" to refer to thermal radiation.可能重新可做 @Rahi-padwal 於 252 天前認領，目前沒有進行中的 PR。 未關閉api easy
難度 2/5 1-3 小時 新手友好度 62/100
pvlib/pvlib-python#2653 · 6 則留言 ·
維護者通常 1 天內回覆
-
question
難度 1/5 1-3 小時 新手友好度 72/100
pvlib/pvlib-python#2637 · 10 則留言 ·
維護者通常 1 天內回覆
查看 pvlib/pvlib-python 的全部 Issue
相似的 Issue
-
tunneld on Windows: Wi-Fi devices are not discovered because uvicorn runs on a ProactorEventLoop未關閉
難度 2/5 1-3 小時 新手友好度 76/100
doronz88/pymobiledevice3#2051 ·
維護者通常 1 天內回覆
-
難度 1/5 1 小時以內 新手友好度 90/100
collabnix/awesome-mcp-lists#230 ·
維護者通常 9 天內回覆
-
Groc schedules with out of range values pass config validation and fail later when the scheduler is built可能已有人在做 @auraseb 今天認領。 未關閉
難度 2/5 1-3 小時 新手友好度 78/100
-
enhancement
難度 2/5 1-3 小時 新手友好度 72/100
autowarefoundation/autoware_carla_scenario#342 ·
維護者通常 1 天內回覆
-
documentation
難度 2/5 1-3 小時 新手友好度 72/100
ianktoo/project-monitor#14 ·