docs: mention defaults in option docs #1013
Merged
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.
Currently finding out the defaults when using the code is a bit cumbersome: most IDEs will give you the docs for the option (e.g.
nats.MaxReconnects
), which currently doesn't mention the defaults. So you have to go to the full docs and click around before getting to the constants.I propose adding the current defaults directly to the method/struct docs, so they are easier to find when coding, without "breaking the flow".
This has the downside of needing more care to be kept up-to-date, but I would argue the trade-off is worth it.
WDYT?