Browse Source

improve docstrings

283
ThomasV 10 years ago
parent
commit
42084a3610
  1. 10
      lib/commands.py

10
lib/commands.py

@ -254,7 +254,7 @@ class Commands:
@command('') @command('')
def validateaddress(self, address): def validateaddress(self, address):
"""Check that the address is valid. """ """Check that an address is valid. """
return is_address(address) return is_address(address)
@command('w') @command('w')
@ -264,7 +264,8 @@ class Commands:
@command('nw') @command('nw')
def getbalance(self, account=None): 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: if account is None:
c, u, x = self.wallet.get_balance() c, u, x = self.wallet.get_balance()
else: else:
@ -297,7 +298,8 @@ class Commands:
@command('n') @command('n')
def getmerkle(self, txid, height): 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] return self.network.synchronous_get([('blockchain.transaction.get_merkle', [txid, int(height)])])[0]
@command('n') @command('n')
@ -315,7 +317,7 @@ class Commands:
@command('w') @command('w')
def getmpk(self): 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() return self.wallet.get_master_public_keys()
@command('wp') @command('wp')

Loading…
Cancel
Save