reaction_methods: fix documented cylinder-constraint radius parameter (bug-sweep #53)#5376
Draft
RudolfWeeber wants to merge 1 commit into
Draft
Conversation
… (bug-sweep #53) The class docstring of ReactionAlgorithm documented the radius parameter of set_cylindrical_constraint_in_z_direction as 'radius_of_cylinder', but the script interface (ReactionAlgorithm.cpp) reads the key 'radius'. A user following the documentation deterministically hit RuntimeError: Parameter 'radius' is missing. Rename the documented parameter to 'radius' to match the script interface and the testsuite. Add a contract test that parses the documented parameter names from the docstring and asserts the script interface accepts them. Co-Authored-By: Claude Opus 4.8 <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
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 class docstring of ReactionAlgorithm documented the radius parameter
of set_cylindrical_constraint_in_z_direction as 'radius_of_cylinder',
but the script interface (ReactionAlgorithm.cpp) reads the key 'radius'.
A user following the documentation deterministically hit
RuntimeError: Parameter 'radius' is missing.
Rename the documented parameter to 'radius' to match the script interface
and the testsuite. Add a contract test that parses the documented
parameter names from the docstring and asserts the script interface
accepts them.
Co-Authored-By: Claude Opus 4.8 noreply@anthropic.com
🤖 Generated with Claude Code