Skip to content

Fix swapped reference numbering in get_bsrn docstring#2680

Merged
cwhanse merged 1 commit intopvlib:mainfrom
aman-coder03:fix/get-bsrn-reference-numbering
Feb 5, 2026
Merged

Fix swapped reference numbering in get_bsrn docstring#2680
cwhanse merged 1 commit intopvlib:mainfrom
aman-coder03:fix/get-bsrn-reference-numbering

Conversation

@aman-coder03
Copy link
Contributor

@aman-coder03 aman-coder03 commented Feb 5, 2026 •
edited by cwhanse
Loading

  • Closes Correct referencing in pvlib.iotools.get_bsrn #2679
  • I am familiar with the contributing guidelines
  • Tests added
  • Updates entries in docs/sphinx/source/reference for API changes.
  • Adds description and name entries in the appropriate "what's new" file in docs/sphinx/source/whatsnew for all changes. Includes link to the GitHub Issue with :issue:`num` or this Pull Request with :pull:`num`. Includes contributor name and/or GitHub username (link with :ghuser:`user`).
  • New code is fully documented. Includes numpydoc compliant docstrings, examples, and comments where necessary.
  • 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 order of references was correct, but labels [3] and [4] were interchanged.

@cwhanse cwhanse added this to the v0.15.1 milestone Feb 5, 2026
@cwhanse
Copy link
Member

cwhanse commented Feb 5, 2026

thanks @aman-coder03 !

@cwhanse cwhanse merged commit 0e92d6c into pvlib:main Feb 5, 2026
33 checks passed
@ramaroesilva
Copy link
Contributor

ramaroesilva commented Feb 5, 2026

@aman-coder03 @cwhanse ups...

imagem

@cwhanse
Copy link
Member

cwhanse commented Feb 5, 2026

Derp. [2] and [4] are reversed. Thank you @ramaroesilva

@aman-coder03
Copy link
Contributor Author

aman-coder03 commented Feb 5, 2026

oops!😅
i will make it rightt no issues, shall I? @cwhanse

@aman-coder03
Copy link
Contributor Author

aman-coder03 commented Feb 5, 2026 

```
References
----------
.. [1] `World Radiation Monitoring Center - Baseline Surface Radiation
    Network (BSRN)
    <https://bsrn.awi.de/>`_
.. [2] `Update of the Technical Plan for BSRN Data Management, 2013,
   Global Climate Observing System (GCOS) GCOS-174.
   <https://bsrn.awi.de/fileadmin/user_upload/bsrn.awi.de/Publications/gcos-174.pdf>`
.. [3] `BSRN Data Retrieval via FTP
   <https://bsrn.awi.de/data/data-retrieval-via-ftp/>`
.. [4] `BSRN Data Release Guidelines
   <https://bsrn.awi.de/data/conditions-of-data-release/>`

@aman-coder03 aman-coder03 deleted the fix/get-bsrn-reference-numbering branch February 5, 2026 17:44
@cwhanse
Copy link
Member

cwhanse commented Feb 5, 2026

@ramaroesilva I looked again. I think the reference order is now correct in iotools.get_bsrn and in iotools.read_bsrn. Where did you get that screenshot?

@cwhanse
Copy link
Member

cwhanse commented Feb 5, 2026

It is somewhat confusing that all three BSRN functions cite the same 4 references, but in a different order that conforms to each function's docstring.

@aman-coder03
Copy link
Contributor Author

aman-coder03 commented Feb 5, 2026

i fixed the order like it was in the screenshot in the #2681

@ramaroesilva
Copy link
Contributor

ramaroesilva commented Feb 5, 2026

@cwhanse, sorry my bad. this printscreen was actually from read_bsrn doc so there may be a separate problem there.

to me, get_bsrn doc looks the same as originally. does the PR automatically show up in the online doc or only when a new version is released? thought it could be a cache issue, but I checked also in anonymous mode and in a different browser and still got the two issues.

@kandersolar
Copy link
Member

kandersolar commented Feb 5, 2026

@ramaroesilva be sure to check https://pvlib-python.readthedocs.io/en/latest/ instead of https://pvlib-python.readthedocs.io/en/stable/. stable only updates when we make a new release. latest reflects the latest commit on the main branch.

@ramaroesilva
Copy link
Contributor

ramaroesilva commented Feb 5, 2026

Thanks @kandersolar! Always learning new things :-)

@aman-coder03, looks great now!

@ramaroesilva ramaroesilva mentioned this pull request Feb 5, 2026
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

documentation

Projects

None yet

Milestone

v0.15.1

Development

Successfully merging this pull request may close these issues.

Correct referencing in pvlib.iotools.get_bsrn

4 participants

@aman-coder03 @cwhanse @ramaroesilva @kandersolar