docs: document packages and fix typo

This commit is contained in:
Markus Richter 2018-01-08 20:20:51 +00:00 committed by Dave Collins
parent 97c4b6b096
commit 1cd9b6805d
4 changed files with 25 additions and 1 deletions

View File

@ -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

8
bloom/doc.go Normal file
View File

@ -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
limits/doc.go Normal file
View File

@ -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
mempool/doc.go Normal file
View File

@ -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