Consider using computed docstrings
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 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時間
- マージ済み PR（30日）
- 13
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
pvlib/pvlib-python のほかの issue
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
pvlib/pvlib-python#2903 · コメント 5 件 · リアクション 2 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1時間未満 初心者へのやさしさ 92/100
pvlib/pvlib-python#2902 ·
メンテナーはふだん 1 日以内に返信
-
Add an example or documentation on using 'bhi' from ERA5再び着手できるかも @anshurajbisoyi98-ctrl が 14 日前に担当しましたが、オープン中のプルリクエストはありません。 オープン
難易度 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 日前に担当しましたが、オープン中のプルリクエストはありません。 オープン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 日以内に返信
-
Remove Datacircleオープン
難易度 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 ·