doc: correct net autoSelectFamilyAttemptTimeout default - #65179
Closed
arhxam wants to merge 1 commit into
Closed
Conversation
The initial default documented for the `value` argument of `net.setDefaultAutoSelectFamilyAttemptTimeout()` was `250`, but the actual default is `500`: `src/node_options.h` initializes `network_family_autoselection_attempt_timeout = 500`, and `net.getDefaultAutoSelectFamilyAttemptTimeout()` returns `500` at runtime. The description of the corresponding getter a few lines above already states `500`. Correct the value so the two agree. Signed-off-by: Arham Wani <arhamwani765@gmail.com>
Collaborator
|
Review requested:
|
nodejs-github-bot
added
doc
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
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.
Description
The initial default documented for the
valueargument ofnet.setDefaultAutoSelectFamilyAttemptTimeout()was250, but theactual default is
500.Evidence:
src/node_options.hinitializesnetwork_family_autoselection_attempt_timeout = 500.At runtime:
The description of the corresponding getter
(
net.getDefaultAutoSelectFamilyAttemptTimeout()) a few lines above inthe same document already states the initial default is
500; onlythis setter entry was stale at
250.This corrects the value so the two entries agree. Documentation-only
change.