Repository navigation
Document the parameter values in the docs - #50
Merged
Merged
Conversation
The page lists every named set and registered layer, with its values, its source and, for the materials and fluids, the temperature at which the values were taken. docs/conf.py writes it at each build from pytes.parameter_layers, so it always matches the code. A new test requires a "Taken at:" line in every fluid, PCM and metal layer. Closes #49 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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.
Closes #49.
A new documentation page, Parameter values, generated at each build from
pytes.parameter_layers, so that it always matches the code.What the page shows
SETS, with a table linking to the layer of each kind it uses.LAYERS, its description, then for each layer:Source:andTaken at:lines rendered as fields;pytes.parameter_layers.get(...)call that returns it;How
docs/parameter_values.pywritesdocs/parameter_values.rst. It is called fromdocs/conf.py, as the changelog and contributing pages are, and the output is gitignored.test_material_layers_state_their_temperature: every fluid, PCM and metal layer must have aTaken at:line. The existingtest_registered_layers_state_their_sourcesalready checks the sources.Notes
docs/index.mdwill conflict trivially withdocs-model-pages(both add a toctree entry).DESIGN.mdorfindings.md: no decision or contract changes.🤖 Generated with Claude Code