Repository navigation
Document useful module-level constants - #2884
Closed
anshurajbisoyi98-ctrl wants to merge 3 commits into
Closed
anshurajbisoyi98-ctrl wants to merge 3 commits into
anshurajbisoyi98-ctrl wants to merge 3 commits into
Conversation
Member
|
@anshurajbisoyi98-ctrl this PR creates a new page to group unrelated constants together, which is not what was discussed in the issue:
Instead of putting all the constants on one page, please put them in existing pages near relevant functions. |
Author
|
Moved the constants to the existing pages near related functions and removed the constants page. Docs build checked. |
Member
|
@anshurajbisoyi98-ctrl thanks for having the AI show how the constants could be documented. We don't have time to fix the placement and text of the constant docstrings in this PR. |
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.
docs/sphinx/source/referencefor API changes.docs/sphinx/source/whatsnewfor 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`).remote-data) and Milestone are assigned to the Pull Request and linked Issue.This change documents useful module-level constants on existing API reference pages near the functions and models they support. The albedo tables appear with irradiance references, the airmass model collections and Hellmann exponents with atmospheric references, and temperature model parameters with temperature models. The constants retain concise module-level docstrings.
Validation
make -C docs/sphinx html: passed;build succeeded(one Sphinx cache warning abouthtml_context). Checked the renderedairmass_atmospheric,irradiance/other, andpv_modeling/temperaturepages; all requested constants are present and no broken-reference warning occurred.pytest -q tests/test_albedo.py tests/test_atmosphere.py tests/test_temperature.py: passed, 64 tests.git diff --check: passed.