Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Default minimum number of peers is documented to be 5 but is actually 0 #4252

Closed
haikoschol opened this issue Oct 15, 2024 · 1 comment
Closed

Default minimum number of peers is documented to be 5 but is actually 0 #4252

haikoschol opened this issue Oct 15, 2024 · 1 comment
Labels
C-simple Minor changes changes, no additional research needed. Good first issue/review. good first issue issues that are suitable for first-time contributors. P-low this is mostly nice to have. S-cli issue related to Gossamer CLI. S-doc documentation related. T-bug this issue covers unexpected and/or wrong behaviour.

Comments

@haikoschol
Copy link
Contributor

Describe the bug

According to the CLI documentation, the default for the --min-peers flag is 5. But in the code it is actually set to 0.

Expected Behavior

Documentation reflects what the code actually does.

Current Behavior

The user is bamboozled.

Possible Solution

I don't think 0 is a useful default and therefore suggest setting DefaultMinPeers to 5.
@haikoschol haikoschol added T-bug this issue covers unexpected and/or wrong behaviour. P-low this is mostly nice to have. C-simple Minor changes changes, no additional research needed. Good first issue/review. S-cli issue related to Gossamer CLI. S-doc documentation related. good first issue issues that are suitable for first-time contributors. labels Oct 15, 2024
programmingwithrp added a commit to programmingwithrp/gossamer that referenced this issue Oct 15, 2024
@programmingwithrp
Fix(Config Setting): Updated DefaultMinPeers to 5 According to the CL…
9187b81 
…I documentation ChainSafe#4252
@programmingwithrp programmingwithrp mentioned this issue Oct 15, 2024
Closed
@haikoschol
Copy link
Contributor Author

fixed by #4257

@haikoschol haikoschol mentioned this issue Oct 17, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
C-simple Minor changes changes, no additional research needed. Good first issue/review. good first issue issues that are suitable for first-time contributors. P-low this is mostly nice to have. S-cli issue related to Gossamer CLI. S-doc documentation related. T-bug this issue covers unexpected and/or wrong behaviour.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@haikoschol