Skip to content

Conversation

AdamRJensen
Copy link
Member

@AdamRJensen AdamRJensen commented Oct 1, 2025

  • I am familiar with the contributing guidelines
  • Updates entries in docs/sphinx/source/reference for API changes.
  • Pull request is nearly complete and ready for detailed review.
  • Maintainer: Appropriate GitHub Labels (including remote-data) and Milestone are assigned to the Pull Request and linked Issue.

The location section of the documentation currently only list one function. As a user I would like to see all the possible functions that can be used with a location object in this section of the documentation.

Therefore, this PR adds the various location object functions to to the location documentation section. Note that these functions are already included in other parts of the documentation (e.g., pvlib.location.Location.get_solarposition is included in the solar position doc section), but we have a history of including functions in two places where it makes sense.

@AdamRJensen AdamRJensen added this to the v0.13.2 milestone Oct 1, 2025
Copy link
Contributor

@echedey-ls echedey-ls left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We already have those methods listed in the own class: https://pvlib-python--2560.org.readthedocs.build/en/2560/reference/generated/pvlib.location.Location.html (as you stated)

I find that enough - I mean, if I, as a user, were curious about a class, I'd look up its methods beforehand. For the specific case of constructors (from_epw, from_tmy), they are more like an interface so don't mind giving them some more importance. I would just redirect users to read docs of Location rather than duplicating it.

It's just my two cents, not a strong opinion. In any case, it seems valuable to assess whether these classes are taking too much/not enough space in the documentation (could adding a third level to the API reference page be of help?). If we go ahead with the duplication:

  1. bear in mind the maintenance it requires (almost negligible for Location thou) - by default listed classes autogenerate their methods list
  2. consider applying the same pattern to other classes or not

Unrelated but for the sake of clarity:
line 6 states: >Methods< for information about locations.
it should be Functions or Procedures.

AdamRJensen and others added 2 commits October 5, 2025 18:26
Co-authored-by: Echedey Luis <[email protected]>
Co-authored-by: Echedey Luis <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants