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.

Sign up for GitHub

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

Jump to bottom

Avoid 'iff' in scaladoc #25486

Closed
raboof opened this issue Aug 17, 2018 · 5 comments
Closed

Avoid 'iff' in scaladoc #25486

raboof opened this issue Aug 17, 2018 · 5 comments
Labels
1 - triaged Tickets that are safe to pick up for contributing in terms of likeliness of being accepted good first issue help wanted Issues that the core team will likely not have time to work on t:docs
Milestone
2.5.18

Comments

@raboof
Copy link
Member

raboof commented Aug 17, 2018

In some places (i.e. "including the first failed element iff inclusive is true" in the javadsl Flow), we use 'iff'. This is not a typo but a 'math-ism' (https://en.wikipedia.org/wiki/If_and_only_if).

It would be nice to use simpler language. Perhaps really spell it out, like: "Terminate processing (and cancel the upstream publisher) after predicate returns false for the first time. When 'inclusive' is true, also include the element for which the predicate returned 'false'."
@raboof raboof added 1 - triaged Tickets that are safe to pick up for contributing in terms of likeliness of being accepted help wanted Issues that the core team will likely not have time to work on t:docs good first issue labels Aug 17, 2018
@raboof raboof mentioned this issue Aug 17, 2018
Merged
@Anjali2019
Copy link

Hi! Is this issue open? I would like to work on it if open, please let me know!

@raboof
Copy link
Member Author

raboof commented Sep 4, 2018

@Anjali2019 yes that would be great!

@Prsna23
Copy link
Contributor

Prsna23 commented Oct 11, 2018

Is this issue still open? If no one is working on it, I would like to make changes.

@patriknw
Copy link
Member

@Prsna23 That would be great, looks like there are some occurrences when searching for iff

@Prsna23
Copy link
Contributor

Prsna23 commented Oct 11, 2018

@patriknw Cool. I will check JavaDSL Flow file and make the changes.

@Prsna23 Prsna23 mentioned this issue Oct 12, 2018
Merged
@johanandren johanandren added this to the 2.5.18 milestone Oct 12, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
1 - triaged Tickets that are safe to pick up for contributing in terms of likeliness of being accepted good first issue help wanted Issues that the core team will likely not have time to work on t:docs
Projects
None yet
Milestone
2.5.18
Development

No branches or pull requests
5 participants
@raboof @patriknw @johanandren @Anjali2019 @Prsna23