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 · 2 条评论 · 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 于 251 天前认领，目前没有进行中的 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
-
难度 2/5 1-3 小时 新手友好度 88/100
NousResearch/hermes-agent#140958 ·
维护者通常 1 天内回复
-
bisect
难度 2/5 1-3 小时 新手友好度 72/100
dtcxzyw/llvm-bisect-service#548 ·
-
难度 2/5 1-3 小时 新手友好度 82/100
sallowayma-git/IELTS-practice#248 ·
维护者通常 1 天内回复
-
难度 1/5 1 小时以内 新手友好度 65/100
anthropics/claude-plugins-official#6763 · 10 条评论 · 10 个 reaction ·
维护者通常 3 天内回复
-
难度 2/5 1-3 小时 新手友好度 85/100
维护者通常 1 天内回复