Clarify contracts of CompositeSubscription in its javadoc #3458
Conversation
This file contains hidden or 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
|
👍 |
| /** | ||
| * Unsubscribes itself and all inner subscriptions. | ||
| * <p>Notice that {@link CompositeSubscription} won't be able | ||
| * to manage new subscriptions after call of this method. |
There was a problem hiding this comment.
I feel this is unclear. You can still add Subscription to a CompositeSubscription after call of this method. How about After call of this method, new {@code Subscription}s added to {@link CompositeSubscription} will be unsubscribed immediately?
artem-zinnatullin
force-pushed
the
CompositeSubscription-javadoc
branch
from
328ddbd to
4c33811
Compare
|
👍 |
|
Excellent! |
akarnokd
added a commit
that referenced
this pull request
Oct 18, 2015
…-javadoc Clarify contracts of CompositeSubscription in its javadoc
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.
Current state of
CompositeSubscription's javadoc — totally misleading 😄Every time we need to store some subscriptions in it then clear them and leave
CompositeSubscriptionin an operable state we have to read its sources because its actual behavior is not consistent with the javadoc.CompositeSubscription.clear()leavesCompositeSubscriptionin operable state, when on the other handCompositeSubscription.unsubscribe()setsisUnsubscribed = trueandCompositeSubscriptionis not able to manage new subscriptions.