DM-15139: Rename invert() and getInverse() to inverted() #49
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
Improve some documentation copied from AST implied that `FrameSet.getInverse` inverted the frame set in place.
r-owen
changed the title
jdswinbank
approved these changes
Aug 12, 2018
include/astshim/Mapping.h
Outdated
| @@ -90,7 +90,7 @@ class Mapping : public Object { | |||
| Is this an inverted mapping? | |||
|
|
|||
| Note: this gets the @ref Mapping_Invert "Invert" attribute. | |||
| This method is not called `getInvert` because that is too similar to @ref getInverse. | |||
| This method is not called `getInvert` because that is too similar to @ref inverted. | |||
There was a problem hiding this comment.
I'm not sure this comment makes sense anymore: isInverted is closer to inverted than getInvert would be. I don't think it's worth changing the API (ie, renaming isInverted to getInvert), although if you were keen to do that I wouldn't object, but I do think we should remove the comment.
There was a problem hiding this comment.
I think it important to say why it is not called getInvert because most of astshim has getX for every attribute X. However, I will change it to say "because that sounds like it might return the inverse". That is a bit more accurate than my original comment.
r-owen
force-pushed
the
tickets/DM-15139
branch
from
6bd03e4
to
4a80b97
Compare
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.
No description provided.