aboutsummaryrefslogtreecommitdiff
path: root/qa/rpc-tests/test_framework/blockstore.py
diff options
context:
space:
mode:
authorJohn Newbery <john@johnnewbery.com>2017-01-17 18:34:40 -0500
committerJohn Newbery <john@johnnewbery.com>2017-02-23 10:31:04 -0500
commit3f95a806b1cd2f3c944bda7bcc266498a59326e4 (patch)
treea1370c242d232e14a1c31a8bf203f7236342b953 /qa/rpc-tests/test_framework/blockstore.py
parent61a640ea9741e5e76b945699a8332b0a9923339b (diff)
downloadbitcoin-3f95a806b1cd2f3c944bda7bcc266498a59326e4.tar.xz
Fix docstrings in qa tests
This commit fixes the module-level docstrings for the tests and helper modules in qa. Many of these tests were uncommented previously - this commit ensures that every test case has at least a minimum level of commenting.
Diffstat (limited to 'qa/rpc-tests/test_framework/blockstore.py')
-rw-r--r--qa/rpc-tests/test_framework/blockstore.py12
1 files changed, 8 insertions, 4 deletions
diff --git a/qa/rpc-tests/test_framework/blockstore.py b/qa/rpc-tests/test_framework/blockstore.py
index 28a6b92b81..5280d18cdc 100644
--- a/qa/rpc-tests/test_framework/blockstore.py
+++ b/qa/rpc-tests/test_framework/blockstore.py
@@ -2,16 +2,20 @@
# Copyright (c) 2015-2016 The Bitcoin Core developers
# Distributed under the MIT software license, see the accompanying
# file COPYING or http://www.opensource.org/licenses/mit-license.php.
-# BlockStore: a helper class that keeps a map of blocks and implements
-# helper functions for responding to getheaders and getdata,
-# and for constructing a getheaders message
-#
+"""BlockStore and TxStore helper classes."""
from .mininode import *
from io import BytesIO
import dbm.dumb as dbmd
class BlockStore(object):
+ """BlockStore helper class.
+
+ BlockStore keeps a map of blocks and implements helper functions for
+ responding to getheaders and getdata, and for constructing a getheaders
+ message.
+ """
+
def __init__(self, datadir):
self.blockDB = dbmd.open(datadir + "/blocks", 'c')
self.currentBlock = 0