pvlib-python icon indicating copy to clipboard operation
pvlib-python copied to clipboard

Inexistent function reference in `pvlib.irradiance.poa_components`

Open echedey-ls opened this issue 1 year ago • 5 comments

The following referenced function does not exist: https://github.com/pvlib/pvlib-python/blob/19c9598355b8243038bdeb1253d219e0371f71af/pvlib/irradiance.py#L474

A alternative should be found and referenced with :py:func:`pvlib.<submodule>.<function_name>`

echedey-ls avatar Jun 15 '24 14:06 echedey-ls

Should point to :py:funcpvlib.irradiance.get_ground_diffuse

cwhanse avatar Jun 15 '24 16:06 cwhanse

Good first issue for newcomers or do you prefer a PR?

echedey-ls avatar Jun 15 '24 18:06 echedey-ls

Good first issue for newcomers or do you prefer a PR?

I like the idea of leaving it, so we have something in case someone comes by.

AdamRJensen avatar Jun 15 '24 19:06 AdamRJensen

I'd like to work on this issue. From what I understand, we need to:

  1. Fix the documentation reference in pvlib/irradiance.py line 474
  2. Change the reference from the non-existent grounddiffuse function to pvlib.irradiance.get_ground_diffuse
  3. Use the correct Sphinx documentation format: :py:func:pvlib.irradiance.get_ground_diffuse

studentayaaljabbari avatar Jun 16 '25 10:06 studentayaaljabbari

@studentayaaljabbari please do!

cwhanse avatar Jun 16 '25 13:06 cwhanse