transit_sunrise_sunset: seems as a public function, not in public docs?

[echedey-ls]

Describe the bug

pvlib-python/pvlib/spa.py

Line 1106 in cbe4cc5

def transit_sunrise_sunset(dates, lat, lon, delta_t, numthreads):

Personally, I don't find any signs that it may be a private function. However, it does not appear in the webpage:

• https://pvlib-python.readthedocs.io/en/stable/search.html?q=transit_sunrise_sunset

Well it's not true: it appears here https://pvlib-python.readthedocs.io/en/stable/reference/generated/pvlib.spa.html
I wasn't around when pvlib.spa didn't get documented, so seeing it's not the only undocumented function, maybe it was deliberate?

Expected
To see its documentation on ReadTheDocs.

Versions:

• pvlib.__version__: 0.11.0

[cwhanse]

In v0.1 when this function was added the documents didn't have the auto-built the API reference pages. Omission was probably to avoid cluttering the solarposition.py module page and only list the most significant functions.

[echedey-ls]

I understand why it didn't get included at that time. For the current status of pvlib, is it desired to publicize it or not? I feel it is a well-documented function that may compete with pvlib.location.Location.get_sun_rise_set_transit. At least that one, I can't speak for the rest of functions. Consider this issue as a potential discussion-opener for that.

[cwhanse]

I don't see any downside to adding this function to the API documentation.

[AdamRJensen]

Agreed, a PR to include it is welcomed 😄