fix #1180: Add missing docs for ConnectOptions #1181
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
barafael
changed the title
Jarema
requested changes
Dec 27, 2023
Member
Jarema
left a comment
Jarema
left a comment
There was a problem hiding this comment.
Thank you for your PR!
Some review notes.
async-nats/src/options.rs
Outdated
| /// By default, client construction will fail if | ||
| /// the connection to the server cannot be established. | ||
| /// | ||
| /// Setting `retry_on_initial_connect` causes client construction |
Member
There was a problem hiding this comment.
It's not exactly how it works. In this case, the handle to the Client is returned immediately and conection is handled asynchronously in the background. Otherwise users would not know the reason for initial connection failure.
Contributor
Author
There was a problem hiding this comment.
I'm not sure I understand - if you don't mind, have a look again.
ConnectOptions::retry_on_initial_connect and ConnectOptions::ignore_discovered_servers
Jarema
approved these changes
Jan 2, 2024
Member
Jarema
left a comment
Jarema
left a comment
There was a problem hiding this comment.
LGTM!
Thank you for your contribution!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
Docs for
ConnectOptions::retry_on_initial_connectandConnectOptions::ignore_discovered_servers.