electrostatics: fix ELC delta_mid_bot docstring typo (bug-sweep #54)#5377
Draft
RudolfWeeber wants to merge 1 commit into
Draft
electrostatics: fix ELC delta_mid_bot docstring typo (bug-sweep #54)#5377RudolfWeeber wants to merge 1 commit into
RudolfWeeber wants to merge 1 commit into
Conversation
The ELC parameter-list docstring documented 'delta_mid_bottom', but the accepted parameter name (used by default_params(), the script-interface AutoParameters/constructor, the docstring's own prose, the Sphinx docs, the tutorials, and every testsuite usage) is 'delta_mid_bot'. A user following the documented name hit a RuntimeError "Parameter 'delta_mid_bottom' is not a valid parameter". Fix the docstring to the established public name 'delta_mid_bot' (the checkpoint-serialized name). Add a docstring-consistency test in coulomb_interface.py that parses the ELC "Parameters" block and asserts every documented field is an accepted parameter (a key of default_params() or a member of required_keys()). Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Contributor
Author
|
Again,, the docstring fix is proabbly valid, but the testcase is over the top. |
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
1 participant
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 ELC parameter-list docstring documented 'delta_mid_bottom', but the
accepted parameter name (used by default_params(), the script-interface
AutoParameters/constructor, the docstring's own prose, the Sphinx docs,
the tutorials, and every testsuite usage) is 'delta_mid_bot'. A user
following the documented name hit a RuntimeError
"Parameter 'delta_mid_bottom' is not a valid parameter".
Fix the docstring to the established public name 'delta_mid_bot' (the
checkpoint-serialized name). Add a docstring-consistency test in
coulomb_interface.py that parses the ELC "Parameters" block and asserts
every documented field is an accepted parameter (a key of
default_params() or a member of required_keys()).
Co-Authored-By: Claude Opus 4.8 noreply@anthropic.com
🤖 Generated with Claude Code