Skip to content

[TYPO / BEGINNERS FRIENDLY] pvlib.solarposition.spa_python parameter atmos_refract documentation has a typoΒ #2532

@echedey-ls

Description

@echedey-ls

Describe the bug
While the parameter for atmospheric refraction in pvlib.solarposition.spa_python is atmos_refract, it is documented as atmos_refrac.

To Reproduce

  1. Compare documentation https://pvlib-python.readthedocs.io/en/stable/reference/generated/pvlib.solarposition.spa_python.html
  2. With the implementation https://github.com/pvlib/pvlib-python/blob/v0.13.0/pvlib/solarposition.py#L281-L389

Expected behavior
To be fixed.

Screenshots

Image Image

Versions:

  • pvlib.__version__: v0.13.0 and latest main confirmed

Additional context
All hail the ruff linter, doc rules (specifically this one).

Warning

I'm saving this issue for potential contributors that, (a) have never contributed to pvlib and (b) do expect to contribute to this library in the future. Please, don't work on this issue without previous agreement.

Metadata

Metadata

Assignees

No one assigned

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions