-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Remove warnings in docs #2128
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
Remove warnings in docs #2128
Conversation
/home/docs/checkouts/readthedocs.org/user_builds/pvlib-python/checkouts/2128/pvlib/temperature.py:docstring of pvlib.temperature.pvsyst_cell:35: WARNING: duplicate label of equation pvsyst, other instance in gallery/floating-pv/plot_floating_pv_cell_temperature
@IoannisSifnaios @RDaxini this documentation log is almost clean. Double-checking exercise left to the reader 🙃 |
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.
LGTM, I can see that the links are working now and you've removed the additional label.
Possible additional revision while we're at it though... in the Plot Irradiance Non-uniformity Loss example, can we separate the first code block (the one importing packages) more distinctly from the references section? I just think it would look neater. I know anyone would know that's not references, but it kinda looks like it is part of that section. Perhaps shift it into the problem description section? It could still be kept as a separate code block from the code block already in that section though. Just an idea.
You've got a point right there @RDaxini , thx! |
Co-Authored-By: RDaxini <143435106+RDaxini@users.noreply.github.com>
Co-Authored-By: RDaxini <143435106+RDaxini@users.noreply.github.com>
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.
LGTM, thanks @echedey-ls!
[ ] Closes #xxxx[ ] Tests added[ ] Updates entries indocs/sphinx/source/reference
for API changes.[ ] Adds description and name entries in the appropriate "what's new" file indocs/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.remote-data
) and Milestone are assigned to the Pull Request and linked Issue.I forgot to check the built docs log ☠️
Second commit has the log output of that equation problem
Fixes