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

Minor documentation rendering improvements #2058

Merged
merged 2 commits into from
May 22, 2024
Merged

Conversation

kandersolar
Copy link
Member

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

This PR fixes a handful of instances like this, where a bulleted list is rendered with quotation formatting:

image

After fixing the indentation, it renders better:

image

It also improves the rendering of a couple of equations I noticed along the way.

Here is a table of the changed docstrings:

Function Stable PR
pvlib.irradiance.reindl link link
pvlib.irradiance.erbs link link
pvlib.irradiance.erbs_driesse link link
pvlib.irradiance.orgill_hollands link link
pvlib.irradiance.boland link link
pvlib.irradiance.gti_dirint link link
pvlib.irradiance.louche link link
pvlib.iam.marion_diffuse link link
pvlib.iam.marion_integrate link link
pvlib.iam.convert link link
pvlib.iam.fit link link
pvlib.pvsystem.sapm_effective_irradiance link link
pvlib.pvsystem.singlediode link link
pvlib.spectrum.spectrl2 link link
pvlib.spectrum.spectral_factor_firstsolar link link

@kandersolar kandersolar added this to the 0.11.0 milestone May 22, 2024
@kandersolar kandersolar merged commit 80761af into pvlib:main May 22, 2024
31 checks passed
@kandersolar kandersolar deleted the docsfix branch May 22, 2024 17:12
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.

2 participants