Repository navigation
Fix/docs improve readability api reference pvsystem - #49
Merged
javlor merged 3 commits intoOct 26, 2026
Merged
Conversation
mikehamer-dnv
approved these changes
Oct 26, 2026
javlor
deleted the
fix/docs-improve-readability-api-reference-pvsystem
branch
October 26, 2026 14:27
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The readability of the PVSystem class in the docs was not correctly formatted as each of the metadata sections was rendered as continuous strings rather than as different attributes.
This was fixed by adding all the attributes under an "Attributes" section in the PVSystem docstring.
The package
mkdocstringis also updated to avoid version 1.0.4, which reported compatibility issues withpymdown-extensions12.3.