2.x: improve autoConnect() Javadoc + add its marble #5756
Merged
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
vanniktech
approved these changes
Dec 6, 2017
| * <p> | ||
| * The connection happens after the first subscription and happens at most once | ||
| * during the lifetime of the returned Flowable. If this ConnectableFlowable | ||
| * terminates, the connection is never renewed, no matter how Subscribers come |
Collaborator
There was a problem hiding this comment.
maybe no matter how many Subscribers
Member
Author
There was a problem hiding this comment.
I don't feel "many" should be there.
artem-zinnatullin
approved these changes
Dec 7, 2017
| * <p> | ||
| * This overload does not allow disconnecting the connection established via | ||
| * {@link #connect(Consumer)}. Use the {@link #autoConnect(int, Consumer)} overload | ||
| * to gain access to the {@code Disposable} representing the only connection. |
Contributor
There was a problem hiding this comment.
nit: add @see refCount() and another overload?
Contributor
There was a problem hiding this comment.
Same below + in ConnectableObservable
Member
Author
There was a problem hiding this comment.
I omitted refCount here because there is no refCount(int) yet and that would confuse readers.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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 improves the JavaDoc of
ConnectableObservable.autoConnect()andConnectableFlowable.autoConnect()operators and adds the respective marble diagrams: