public inbox for bitcoindev@googlegroups.com
 help / color / mirror / Atom feed
From: "David A. Harding" <dave@dtrt.org>
To: Dario Teixeira <dario.teixeira@nleyten.com>
Cc: bitcoin-development@lists.sourceforge.net
Subject: Re: [Bitcoin-development] More precise type information in API reference
Date: Tue, 17 Feb 2015 10:50:12 -0500	[thread overview]
Message-ID: <20150217155011.GA5124@localhost.localdomain> (raw)
In-Reply-To: <cc1f451ed0bcad909d203ece06e1040a@nleyten.com>

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



  reply	other threads:[~2015-02-17 16:32 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-02-17 13:00 [Bitcoin-development] More precise type information in API reference Dario Teixeira
2015-02-17 13:33 ` Dario Teixeira
2015-02-17 15:50   ` David A. Harding [this message]
2015-02-17 18:46     ` Dario Teixeira

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20150217155011.GA5124@localhost.localdomain \
    --to=dave@dtrt.org \
    --cc=bitcoin-development@lists.sourceforge.net \
    --cc=dario.teixeira@nleyten.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox