-
Notifications
You must be signed in to change notification settings - Fork 479
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.
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
docs: p2p package overview #6096
Conversation
f20f860
to
bcd818f
Compare
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #6096 +/- ##
==========================================
- Coverage 56.25% 55.93% -0.32%
==========================================
Files 490 490
Lines 69699 69706 +7
==========================================
- Hits 39206 38993 -213
- Misses 27825 28004 +179
- Partials 2668 2709 +41 ☔ View full report in Codecov by Sentry. |
bcd818f
to
c1cd118
Compare
13e8d67
to
edcdda5
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good I have just a few minor comments
Co-authored-by: Jason Paulos <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Put in some wording suggestions for the READMEs along with a question about the isGossipServer
checks.
Co-authored-by: Gary Malouf <[email protected]>
@jasonpaulos / @gmalouf thank you for corrections! All applied. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Overall I like - I do wonder where we put the clear recommendation to bias towards using the appropriate hybrid profiles (and making sure they are aware of the appropriate settings) for users interesting in exercising the P2P network out of the gate.
Summary
network/p2p/README.md
network/README-P2P.md
While writing this doc found and fixed the following:
peer.GetHTTPClient()
returning nil sinceMakeHTTPClient
for p2p net can err.