Skip to content
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

Merged
merged 3 commits into from
Jul 5, 2017
Merged

fix small spelling errors #1264

merged 3 commits into from
Jul 5, 2017

Conversation

marcpiechura
Copy link
Contributor

No description provided.

@akka-ci
Copy link

akka-ci commented Jul 3, 2017

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()).
Copy link
Member

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.

Copy link
Contributor Author

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.

Copy link
Member

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?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sounds good

@raboof
Copy link
Member

raboof commented Jul 3, 2017

OK TO TEST

@raboof
Copy link
Member

raboof commented Jul 3, 2017

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.

@akka-ci akka-ci added validating PR that is currently being validated by Jenkins tested PR that was successfully built and tested by Jenkins and removed validating PR that is currently being validated by Jenkins labels Jul 3, 2017
@akka-ci
Copy link

akka-ci commented Jul 3, 2017

Test PASSed.

@ktoso
Copy link
Member

ktoso commented Jul 3, 2017

I like the iff a lot :-(

@akka-ci akka-ci added validating PR that is currently being validated by Jenkins and removed tested PR that was successfully built and tested by Jenkins labels Jul 3, 2017
@marcpiechura
Copy link
Contributor Author

I have no strong opinions against iff, just thought it's a typo, so you could also keep it as it is and close this one ;-)

@akka-ci akka-ci added tested PR that was successfully built and tested by Jenkins and removed validating PR that is currently being validated by Jenkins labels Jul 3, 2017
@akka-ci
Copy link

akka-ci commented Jul 3, 2017

Test PASSed.

@raboof
Copy link
Member

raboof commented Jul 3, 2017

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 :)

@jrudolph
Copy link
Member

jrudolph commented Jul 5, 2017

In my opinion we should replace it with "if and only if" which is the accurate expansion of "iff".

@ktoso
Copy link
Member

ktoso commented Jul 5, 2017

That also sounds like a good idea (to spell out if and only if) 👍

@marcpiechura
Copy link
Contributor Author

Done ;-)

@akka-ci akka-ci added validating PR that is currently being validated by Jenkins tested PR that was successfully built and tested by Jenkins and removed tested PR that was successfully built and tested by Jenkins validating PR that is currently being validated by Jenkins labels Jul 5, 2017
@akka-ci
Copy link

akka-ci commented Jul 5, 2017

Test PASSed.

@jrudolph
Copy link
Member

jrudolph commented Jul 5, 2017

Thanks ;)

@jrudolph jrudolph merged commit d325304 into akka:master Jul 5, 2017
Copy link
Member

@ktoso ktoso left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

ktoso pushed a commit to ktoso/akka-http that referenced this pull request Jul 18, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
tested PR that was successfully built and tested by Jenkins
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants