-
Notifications
You must be signed in to change notification settings - Fork 594
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fix small spelling errors #1264
Conversation
Can one of the repo owners verify this patch? |
@@ -26,7 +26,7 @@ | |||
public abstract String lowercaseName(); | |||
|
|||
/** | |||
* Returns true iff nameInLowerCase.equals(lowercaseName()). | |||
* Returns true if nameInLowerCase.equals(lowercaseName()). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm afraid this was not entirely a typo: "iff" is sometimes short for "if any only if" (https://en.wikipedia.org/wiki/If_and_only_if).
Might still be nice to replace this with something less obscure - perhaps "Returns true if nameInLowerCase.equals(lowercaseName()), false otherwise"? A bit verbose though.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Interesting, didn't know that 😃
What about Returns only true if...
?
I mean Boolean
kind of implies that it returns false otherwise.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yes, or Returns true exactly when
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
sounds good
OK TO TEST |
Thanks for taking the time to prepare this patch! As I noted above 'iff' actually means something, but it might be good to not use such obscure language in our API documentation. |
Test PASSed. |
I like the |
I have no strong opinions against |
Test PASSed. |
I kind of like 'iff', though it's hard to say how clear it is (esp to non-native speakers perhaps?)... I'm OK with either merging or closing :) |
In my opinion we should replace it with "if and only if" which is the accurate expansion of "iff". |
That also sounds like a good idea (to spell out |
Done ;-) |
Test PASSed. |
Thanks ;) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks!
No description provided.