From b355e9ed8e20d922f5b37e54bed85c53fc492b7d Mon Sep 17 00:00:00 2001 From: Kay Kurokawa Date: Fri, 23 Jun 2017 14:47:28 -0400 Subject: [PATCH] make accurate docstring of claim_show --- lbrynet/daemon/Daemon.py | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/lbrynet/daemon/Daemon.py b/lbrynet/daemon/Daemon.py index 24edba04b..6c256f751 100644 --- a/lbrynet/daemon/Daemon.py +++ b/lbrynet/daemon/Daemon.py @@ -1317,20 +1317,21 @@ class Daemon(AuthJSONRPCServer): @defer.inlineCallbacks def jsonrpc_claim_show(self, txid=None, nout=None, claim_id=None): """ - Resolve claim info from a LBRY name + Resolve claim info from txid/nout or with claim ID Usage: claim_show [ | --txid=] [ | --nout=] [ | --claim_id=] Options: - , --txid= : look for claim with this txid - , --nout= : look for claim with this nout + , --txid= : look for claim with this txid, nout must + also be specified + , --nout= : look for claim with this nout, txid must + also be specified , --claim_id= : look for claim with this claim id Returns: - (dict) Dictionary contaning claim info, (bool) false if claim is not - resolvable + (dict) Dictionary containing claim info as below, { 'txid': (str) txid of claim @@ -1341,6 +1342,13 @@ class Daemon(AuthJSONRPCServer): 'claim_id': (str) claim ID of claim 'supports': (list) list of supports associated with claim } + + if claim cannot be resolved, dictionary as below will be returned + + { + 'error': (str) reason for error + } + """ if claim_id is not None and txid is None and nout is None: claim_results = yield self.session.wallet.get_claim_by_claim_id(claim_id)