Skip to content
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

Merged
merged 5 commits into from
Jul 22, 2024
Merged

Remove warnings in docs #2128

merged 5 commits into from
Jul 22, 2024

Conversation

echedey-ls
Copy link
Contributor

@echedey-ls echedey-ls commented Jul 12, 2024

  • [ ] Closes #xxxx
  • 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.

I forgot to check the built docs log ☠️
Second commit has the log output of that equation problem

/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
@echedey-ls echedey-ls changed the title Fix links at plot_irradiance_nonuniformity_loss.py Remove warnings in docs Jul 12, 2024
@echedey-ls echedey-ls marked this pull request as ready for review July 12, 2024 22:00
@echedey-ls
Copy link
Contributor Author

@IoannisSifnaios @RDaxini this documentation log is almost clean. Double-checking exercise left to the reader 🙃

Copy link
Contributor

@RDaxini RDaxini left a 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.

@echedey-ls
Copy link
Contributor Author

can we separate the first code block (the one importing packages)

You've got a point right there @RDaxini , thx!

echedey-ls and others added 3 commits July 15, 2024 20:48
Co-Authored-By: RDaxini <143435106+RDaxini@users.noreply.github.com>
Co-Authored-By: RDaxini <143435106+RDaxini@users.noreply.github.com>
@kandersolar kandersolar added this to the v0.11.1 milestone Jul 22, 2024
Copy link
Member

@kandersolar kandersolar left a 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!

@kandersolar kandersolar merged commit 899b10c into pvlib:main Jul 22, 2024
31 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants