-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Add location class functions to location documentation section #2560
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Add location class functions to location documentation section #2560
Conversation
There was a problem hiding this 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:
- bear in mind the maintenance it requires (almost negligible for
Location
thou) - by default listed classes autogenerate their methods list - 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
.
Co-authored-by: Echedey Luis <[email protected]>
Co-authored-by: Echedey Luis <[email protected]>
docs/sphinx/source/reference
for API changes.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.