2.x: update javadoc of flatMap() overloads #5127
Merged
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.
This PR rewords the Javadoc of
Flowable.flatMap()
overloads to correctly express their behavior regarding backpressure towards their upstream. In 2.x, onlymerge()
operators are unbounded-in by default,flatMap
s are by default bounded bybufferSize()
or themaxConcurrency
parameter.In addition, one of the
flatMap
overload still hadresultSelector
instead of the commoncombiner
parameter name. As far as I know, there are no language-specific libraries targeting 2.x yet where in the language the actual parameter names are also part of the signature and changing them counts as an incompatible change.Related #5126.