From e7f1f91a49f896005f46f0f2d346d62a9c3848f3 Mon Sep 17 00:00:00 2001 From: "Adam R. Jensen" <39184289+AdamRJensen@users.noreply.github.com> Date: Wed, 1 Oct 2025 08:59:55 +0200 Subject: [PATCH 1/5] Add location class functions to location documentation section --- docs/sphinx/source/reference/location.rst | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/docs/sphinx/source/reference/location.rst b/docs/sphinx/source/reference/location.rst index 28ef46812a..cf9414e02e 100644 --- a/docs/sphinx/source/reference/location.rst +++ b/docs/sphinx/source/reference/location.rst @@ -9,3 +9,23 @@ Methods for information about locations. :toctree: generated/ location.lookup_altitude + +A :py:class:`~pvlib.location.Location` object may be created from the +metadata returned by some file types. + +.. autosummary:: + :toctree: generated/ + + location.Location.from_tmy + location.Location.from_epw + +Methods for calculating time series of certain variables for a given +location. + +.. autosummary:: + :toctree: generated/ + + location.Location.get_airmass + location.Location.get_solarposition + location.Location.get_sun_rise_set_transit + location.Location.get_clearsky From 692e9cea4003083614abcae93a0d50d852c9682e Mon Sep 17 00:00:00 2001 From: "Adam R. Jensen" <39184289+AdamRJensen@users.noreply.github.com> Date: Sun, 5 Oct 2025 18:26:38 +0200 Subject: [PATCH 2/5] Remove class methods Co-authored-by: Echedey Luis <80125792+echedey-ls@users.noreply.github.com> --- docs/sphinx/source/reference/location.rst | 10 ---------- 1 file changed, 10 deletions(-) diff --git a/docs/sphinx/source/reference/location.rst b/docs/sphinx/source/reference/location.rst index cf9414e02e..c17e5e314d 100644 --- a/docs/sphinx/source/reference/location.rst +++ b/docs/sphinx/source/reference/location.rst @@ -19,13 +19,3 @@ metadata returned by some file types. location.Location.from_tmy location.Location.from_epw -Methods for calculating time series of certain variables for a given -location. - -.. autosummary:: - :toctree: generated/ - - location.Location.get_airmass - location.Location.get_solarposition - location.Location.get_sun_rise_set_transit - location.Location.get_clearsky From 9f0087c2e21d0ab7c40bfcff39b46b4d9a48d4f1 Mon Sep 17 00:00:00 2001 From: "Adam R. Jensen" <39184289+AdamRJensen@users.noreply.github.com> Date: Sun, 5 Oct 2025 18:27:00 +0200 Subject: [PATCH 3/5] Add reviewer suggestion Co-authored-by: Echedey Luis <80125792+echedey-ls@users.noreply.github.com> --- docs/sphinx/source/reference/location.rst | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/docs/sphinx/source/reference/location.rst b/docs/sphinx/source/reference/location.rst index c17e5e314d..046719d2c1 100644 --- a/docs/sphinx/source/reference/location.rst +++ b/docs/sphinx/source/reference/location.rst @@ -10,12 +10,18 @@ Methods for information about locations. location.lookup_altitude +Classes +------- +.. autosummary:: + :toctree: generated/ + + location.Location A :py:class:`~pvlib.location.Location` object may be created from the -metadata returned by some file types. - +metadata returned by these file types: .. autosummary:: :toctree: generated/ - location.Location.from_tmy location.Location.from_epw +Methods for calculating time series of certain variables for a given +location are available through this class. From f5a769b9ccd94e64f3a224a505e8cbb9cd5d12e4 Mon Sep 17 00:00:00 2001 From: "Adam R. Jensen" <39184289+AdamRJensen@users.noreply.github.com> Date: Sun, 5 Oct 2025 22:19:36 +0200 Subject: [PATCH 4/5] Apply suggestions from code review --- docs/sphinx/source/reference/location.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/sphinx/source/reference/location.rst b/docs/sphinx/source/reference/location.rst index 046719d2c1..06597fd054 100644 --- a/docs/sphinx/source/reference/location.rst +++ b/docs/sphinx/source/reference/location.rst @@ -18,6 +18,7 @@ Classes location.Location A :py:class:`~pvlib.location.Location` object may be created from the metadata returned by these file types: + .. autosummary:: :toctree: generated/ location.Location.from_tmy From 654ac4fdbc10639e79c5671b6bbe627378d2f9bc Mon Sep 17 00:00:00 2001 From: "Adam R. Jensen" <39184289+AdamRJensen@users.noreply.github.com> Date: Mon, 6 Oct 2025 10:17:09 +0200 Subject: [PATCH 5/5] Add correct spacing --- docs/sphinx/source/reference/location.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sphinx/source/reference/location.rst b/docs/sphinx/source/reference/location.rst index 06597fd054..ec14e9455d 100644 --- a/docs/sphinx/source/reference/location.rst +++ b/docs/sphinx/source/reference/location.rst @@ -18,9 +18,9 @@ Classes location.Location A :py:class:`~pvlib.location.Location` object may be created from the metadata returned by these file types: - .. autosummary:: :toctree: generated/ + location.Location.from_tmy location.Location.from_epw Methods for calculating time series of certain variables for a given