docs: update advanced/device-numconnections for new default - #1009
Open
93-infinity wants to merge 1 commit into
Open
93-infinity wants to merge 1 commit into
93-infinity wants to merge 1 commit into
Conversation
Copy link
Copy Markdown
Contributor
Sorry, something went wrong.
As indicated in `lib/config/deviceconfiguration.go`, specifically `const defaultNumConnections = 3`, the default value went from 1→3 in 2.x. The changes I propose are as follows: (0) Make no changes to the introduction sentence: "numConnections[...]. A zero value means to use the Syncthing default." Referencing the specific default value of 3 here would be repetitive and would nullify the need to reference it in the sections below, where it serves a much greater purpose. At this point in the text the reader needs to know the default, not its exact value. (1) Keep "single connection" section. While this section technically could have been removed since it is implied by the following one, users who have hardcoded the default value of 1, or users who want a counterpoint to the "maximum 128" section may still find it useful. (2) Modify the "multiple connections" section to indicate the new default of 3, and highlight that it is now the new default, in a way that avoids redundancy with the previous section. (3) Make no changes to "maximum 128" section.
This branch has not been deployed
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
1 participant
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.
As indicated in lib/config/deviceconfiguration.go, specifically const defaultNumConnections = 3, the default value went from 1→3 in 2.x.
The changes I propose are as follows:
(0) Make no changes to the introduction sentence:
"numConnections[...]. A zero value means to use the Syncthing default."
Referencing the specific default value of 3 here would be repetitive and would nullify the need to reference it in the sections below, where it serves a much greater purpose. At this point in the text the reader needs to know the default, not its exact value.
(1) Keep "single connection" section. While this section technically could have been removed since it is implied by the following one, users who have hardcoded the default value of 1, or users who want a counterpoint to the "maximum 128" section may still find it useful.
(2) Modify the "multiple connections" section to indicate the new default of 3, and highlight that it is now the new default in the comparison section, in a way that avoids redundancy with the previous section.
(3) Make no changes to "maximum 128" section.