This repository has been archived by the owner on Feb 1, 2023. It is now read-only.
Add missing godoc comments, refactor to avoid confusion #117
Conversation
This file contains 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
ghost
assigned 
hannahhoward
requested review from
michaelavila,
hsanjuan,
Stebalien and
eingenito
and removed request for
michaelavila
Stebalien
approved these changes
May 10, 2019
peermanager/peermanager.go
Outdated
| @@ -28,7 +36,8 @@ type peerQueueInstance struct { | |||
| // PeerManager manages a pool of peers and sends messages to peers in the pool. | |||
| type PeerManager struct { | |||
| // peerQueues -- interact through internal utility functions get/set/remove/iterate | |||
| peerQueues map[peer.ID]*peerQueueInstance | |||
| peerQueues map[peer.ID]*peerQueueInstance | |||
| peerQueuesLk sync.RWMutex | |||
There was a problem hiding this comment.
oh, no that's a mistake. will remove.
|
Thanks, I'll have a closer look in the following days and give some feedback if needed. |
Add comments to all exported functions, extract the utils for creating instances in testnet.go, moves integration tests to bitswap_test BREAKING CHANGE: removed one constant -- rebroadcastDelay -- which I believe was unused
Instance generator was previously named session generator, which created confusion with bitswap sessions fix #101
hannahhoward
force-pushed
the
feat/improve-docs
branch
from
dc03ebf to
7af3e0a
Compare
Stebalien
approved these changes
May 10, 2019
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Goals
This is the first of probably a few PRs to continue bitswap cleanup -- just clearing up ongoing areas of confusion and reducing accumulated tech debt. This immediate PR is simply to solve #101 -- improve the godocs and clear up confusion due to naming conflicts
Implementation