timprove docstrings - electrum - Electrum Bitcoin wallet
HTML git clone https://git.parazyd.org/electrum
DIR Log
DIR Files
DIR Refs
DIR Submodules
---
DIR commit 42084a3610fb147aba260710fb409ccb35707751
DIR parent 444082f90f05f047e3e9a0287037f45822d46046
HTML Author: ThomasV <thomasv@gitorious>
Date: Fri, 12 Jun 2015 10:34:45 +0200
improve docstrings
Diffstat:
M lib/commands.py | 10 ++++++----
1 file changed, 6 insertions(+), 4 deletions(-)
---
DIR diff --git a/lib/commands.py b/lib/commands.py
t@@ -254,7 +254,7 @@ class Commands:
@command('')
def validateaddress(self, address):
- """Check that the address is valid. """
+ """Check that an address is valid. """
return is_address(address)
@command('w')
t@@ -264,7 +264,8 @@ class Commands:
@command('nw')
def getbalance(self, account=None):
- """Return the balance of your wallet"""
+ """Return the balance of your wallet. If run with the --offline flag,
+ returns the last known balance."""
if account is None:
c, u, x = self.wallet.get_balance()
else:
t@@ -297,7 +298,8 @@ class Commands:
@command('n')
def getmerkle(self, txid, height):
- """Get Merkle branch of a transaction included in a block"""
+ """Get Merkle branch of a transaction included in a block. Electrum
+ uses this to verify transactions (Simple Payment Verification)."""
return self.network.synchronous_get([('blockchain.transaction.get_merkle', [txid, int(height)])])[0]
@command('n')
t@@ -315,7 +317,7 @@ class Commands:
@command('w')
def getmpk(self):
- """Get Master Public Key. Return your wallet\'s master public key"""
+ """Get master public key. Return your wallet\'s master public key(s)"""
return self.wallet.get_master_public_keys()
@command('wp')