Fix RWMol::addAtom docstring #6477
Merged
Conversation
This file contains 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
The docstring claimed that it returned the new number of atoms. It actually returns the index of the new atom. I think it makes more sense to change the documentation than the behavior, because callers are definitely out there using the current behavior.
greglandrum
pushed a commit
that referenced
this pull request
Aug 17, 2023
The docstring claimed that it returned the new number of atoms. It actually returns the index of the new atom. I think it makes more sense to change the documentation than the behavior, because callers are definitely out there using the current behavior.
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.
The docstring claimed that it returned the new number of atoms. It actually returns the index of the new atom.
I think it makes more sense to change the documentation than the behavior, because callers are definitely out there using the current behavior.