Document useful module-level constants - #2884
Open
anshurajbisoyi98-ctrl wants to merge 1 commit into
Open
anshurajbisoyi98-ctrl wants to merge 1 commit into
anshurajbisoyi98-ctrl wants to merge 1 commit into
Conversation
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 creates a dedicated constants page because useful module-level lookup tables and model-name collections were difficult to discover in the source and were not consistently linked from the API reference. It documents the albedo tables, airmass model collections, Hellmann wind exponents, and temperature model parameters in one place, while retaining the temperature reference as a direct link to that shared page. The corresponding constants now have concise module-level docstrings.
Validation
make -C docs/sphinx clean && make -C docs/sphinx html SPHINXOPTS='-W --keep-going -n': completed with 2,014 existing nitpicky warnings from legacy documentation; no warnings referenced the changed constants page or changed source claims. The command reportsbuild finished with problemsbecause strict mode treats warnings as errors.make -C docs/sphinx html: passed;build succeeded.make -C docs/sphinx linkcheck SPHINXOPTS='-W --keep-going -n': stopped after 120 seconds because the external link check was still running; partial output contained 2,010 warnings, primarily legacy nitpicky references. No changed-file link failure was observed.git diff --check: passed.flake8 pvlib/albedo.py pvlib/atmosphere.py: passed.pytest -q tests/test_albedo.py tests/test_atmosphere.py tests/test_temperature.py: passed, 64 tests.docs/sphinx/build/html/reference/constants.htmlcontains all eight requested constants:SURFACE_ALBEDOS,WATER_COLOR_COEFFS,WATER_ROUGHNESS_COEFFS,APPARENT_ZENITH_MODELS,TRUE_ZENITH_MODELS,AIRMASS_MODELS,HELLMANN_SURFACE_EXPONENTS, andTEMPERATURE_MODEL_PARAMETERS.