docs: point to SetDefaultServiceLimits in ResourceManager option #1636
Conversation
This file contains 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
marten-seemann
force-pushed
the
document-rcmgr-libp2p-limits
branch
from
b070c51
to
c8b622d
Compare
marten-seemann
changed the title
MarcoPolo
approved these changes
Jul 2, 2022
| @@ -342,6 +342,8 @@ func ConnectionGater(cg connmgr.ConnectionGater) Option { | |||
| } | |||
|
|
|||
| // ResourceManager configures libp2p to use the given ResourceManager. | |||
| // When using the go-libp2p-resource-manager implementation of the ResourceManager interface, | |||
| // it is recommended to set limits for libp2p protocol by calling SetDefaultServiceLimits. | |||
There was a problem hiding this comment.
(optional) What do you think about adding an example that gets rendered in the godoc here too?
https://pkg.go.dev/github.com/fluhus/godoc-tricks#Examples
There was a problem hiding this comment.
That's a good idea, but we should do that after we've updated the resource manager to include the config refactor.
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.
No description provided.