summaryrefslogtreecommitdiff
path: root/32/b195326dad8ff1ec6ddd1471f956a9e51292c0
blob: 7130e3de28f74401cb96c9c09720f4ef20a4edce (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
Received: from sog-mx-2.v43.ch3.sourceforge.com ([172.29.43.192]
	helo=mx.sourceforge.net)
	by sfs-ml-1.v29.ch3.sourceforge.com with esmtp (Exim 4.76)
	(envelope-from <dave@dtrt.org>) id 1YNl45-0005P3-N8
	for bitcoin-development@lists.sourceforge.net;
	Tue, 17 Feb 2015 16:32:01 +0000
X-ACL-Warn: 
Received: from mail.dtrt.org ([207.192.75.234])
	by sog-mx-2.v43.ch3.sourceforge.com with esmtps (TLSv1:AES256-SHA:256)
	(Exim 4.76) id 1YNl44-0002Mk-0l
	for bitcoin-development@lists.sourceforge.net;
	Tue, 17 Feb 2015 16:32:01 +0000
Received: from harding by mail.dtrt.org with local (Exim 4.72)
	(envelope-from <dave@dtrt.org>)
	id 1YNkVk-00039G-7z; Tue, 17 Feb 2015 10:56:32 -0500
Date: Tue, 17 Feb 2015 10:50:12 -0500
From: "David A. Harding" <dave@dtrt.org>
To: Dario Teixeira <dario.teixeira@nleyten.com>
Message-ID: <20150217155011.GA5124@localhost.localdomain>
References: <9ec9df3b0ecb854fa19bd9100ed87d85@nleyten.com>
	<cc1f451ed0bcad909d203ece06e1040a@nleyten.com>
MIME-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
In-Reply-To: <cc1f451ed0bcad909d203ece06e1040a@nleyten.com>
User-Agent: Mutt/1.5.23 (2014-03-12)
X-Spam-Score: -0.0 (/)
X-Spam-Report: Spam Filtering performed by mx.sourceforge.net.
	See http://spamassassin.org/tag/ for more details.
	-0.0 T_RP_MATCHES_RCVD Envelope sender domain matches handover relay
	domain
X-Headers-End: 1YNl44-0002Mk-0l
Cc: bitcoin-development@lists.sourceforge.net
Subject: Re: [Bitcoin-development] More precise type information in API
 reference
X-BeenThere: bitcoin-development@lists.sourceforge.net
X-Mailman-Version: 2.1.9
Precedence: list
List-Id: <bitcoin-development.lists.sourceforge.net>
List-Unsubscribe: <https://lists.sourceforge.net/lists/listinfo/bitcoin-development>,
	<mailto:bitcoin-development-request@lists.sourceforge.net?subject=unsubscribe>
List-Archive: <http://sourceforge.net/mailarchive/forum.php?forum_name=bitcoin-development>
List-Post: <mailto:bitcoin-development@lists.sourceforge.net>
List-Help: <mailto:bitcoin-development-request@lists.sourceforge.net?subject=help>
List-Subscribe: <https://lists.sourceforge.net/lists/listinfo/bitcoin-development>,
	<mailto:bitcoin-development-request@lists.sourceforge.net?subject=subscribe>
X-List-Received-Date: Tue, 17 Feb 2015 16:32:01 -0000

On Tue, Feb 17, 2015 at 01:33:28PM +0000, Dario Teixeira wrote:
> From this stems my request: please consider defining
> more precisely the type information associated with each API call
> in the JSON-RPC reference [3].

Hi Dario,

I'm the primary author of the Bitcoin.org JSON-RPC reference, and I'd
be happy to help.

Do you think it would be possible for you to submit a minimal pull
request against the docs adding the type information you need to just
one RPC call?  From there we can see how much work it would take to
generalize that across all 100+ printed pages worth of RPC docs.

I've tried to make this as easy as possible: if you hover your mouse
over the title of an RPC[1], an "Edit" link will appear that will take you
to a page on GitHub to edit the file describing that RPC call.  Or you
can checkout[2] the website repository and edit the file locally; the
individual RPCs are in _includes/ref/bitcoin-core/rpcs/rpcs/

    [1] For example, https://bitcoin.org/en/developer-reference#addmultisigaddress
    [2] https://github.com/bitcoin/bitcoin.org

If you have any questions about the editing process, or anything else,
please feel free to email me at this address or PM harding on Freenode.

Thanks!,

-Dave
-- 
David A. Harding