Skip to content

Commit

Permalink
docs: document packages and fix typo
Browse files Browse the repository at this point in the history
  • Loading branch information
markusrichter authored and davecgh committed Jan 8, 2018
1 parent 97c4b6b commit 1cd9b68
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 1 deletion.
2 changes: 1 addition & 1 deletion addrmgr/doc.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Address Manager Overview
In order maintain the peer-to-peer Decred network, there needs to be a source
of addresses to connect to as nodes come and go. The Decred protocol provides
a the getaddr and addr messages to allow peers to communicate known addresses
the getaddr and addr messages to allow peers to communicate known addresses
with each other. However, there needs to a mechanism to store those results and
select peers from them. It is also important to note that remote peers can't
be trusted to send valid peers nor attempt to provide you with only peers they
Expand Down
8 changes: 8 additions & 0 deletions bloom/doc.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
// Copyright (c) 2018 The Decred developers
// Use of this source code is governed by an ISC
// license that can be found in the LICENSE file.

/*
Package bloom provides an API for dealing with decred-specific bloom filters.
*/
package bloom
8 changes: 8 additions & 0 deletions limits/doc.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
// Copyright (c) 2018 The Decred developers
// Use of this source code is governed by an ISC
// license that can be found in the LICENSE file.

/*
Package limits allows to raises some process limits.
*/
package limits
8 changes: 8 additions & 0 deletions mempool/doc.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
// Copyright (c) 2018 The Decred developers
// Use of this source code is governed by an ISC
// license that can be found in the LICENSE file.

/*
Package mempool implements a memory pool to store (unconfirmed) transactions.
*/
package mempool

0 comments on commit 1cd9b68

Please sign in to comment.