Update parameter names in FEModel3D methods for consistency of API #194
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.
Hi @JWock82,
I noticed that there were some breaking changes to the API with recent versions but that the updates were not applied to all of the methods in
FEModel3D
. I have updated the rest of the parameter names across theFEModel3D
object by following what seemed to be the desired new convention. Here is how I understand it:.add_node
) will accept a parameter calledname
to set the name of the object in the model.member_name
(as opposed toMember
) to make it clear that this parameter is to accept a name and not aMember
object itself.I ran the test suite and all tests pass. However, I notice that the test suite does not use any keyword arguments when the methods are called. The tests passing will reflect that the parameter name changes I made in the function signatures have been updated in the function implementations and not that I have followed the naming convention perfectly (although, from manual review, I think I have).
Let me know your thoughts on this?