doc: fix doc for with_limits methods #2682
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
|
A couple more potential inconsistencies to check: In server/builder.rs, the example for the with_endpoint_limits method says "Sets the max inflight handshakes for an endpoint, while inheriting the remaining default limits", but the example code doesn't actually set any max inflight handshakes - it just uses the default endpoint limits. In stream/bidirectional.rs, the example for the id() method shows using connection.open_send_stream() which returns a SendStream, but the method is supposed to demonstrate the id() method of a BidirectionalStream. The example should use connection.open_bidirectional_stream() instead. |
* fix another inconsistency for with_endpoint_limits * fix another inconsistency for id()
WesleyRosenblum
approved these changes
Jun 26, 2025
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.
Release Summary:
Resolved issues:
Description of changes:
The
with_limits()methods for client and server endpoints are wrong. According to the doc, we should explain how to set the maximum idle timeout for an endpoint, while keep all the other default settings. However, the example that we provided doesn't fulfill that requirement.Hence, I need to update the doc with the correct way of setting the maximum idle timeout.
Call-outs:
Testing:
I wrote it locally on my machine, and it success to compile.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.