Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: clarify RPC rawtransaction documentation #14808

Merged
merged 1 commit into from Nov 26, 2018

Conversation

Projects
None yet
5 participants
@jlopp
Copy link
Contributor

commented Nov 26, 2018

Fixing an RPC documentation typo and clarifying the wording of the testmempoolaccept function.

@kristapsk

This comment has been minimized.

Copy link
Contributor

commented Nov 26, 2018

utACK 848077f

@promag
Copy link
Member

left a comment

utACK 848077f.

@@ -939,7 +939,7 @@ static UniValue signrawtransactionwithkey(const JSONRPCRequest& request)
"this transaction depends on but may not yet be in the block chain.\n",
{
{"hexstring", RPCArg::Type::STR, false},
{"privkyes", RPCArg::Type::ARR,
{"privkeys", RPCArg::Type::ARR,

This comment has been minimized.

This comment has been minimized.

Copy link
@MarcoFalke

MarcoFalke Nov 26, 2018

Member

Good catch. Currently the argument names of arrays are not used in any way to produce the string by RPCHelpMan, only after #14796.

@DrahtBot

This comment has been minimized.

Copy link
Contributor

commented Nov 26, 2018

The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.

Conflicts

Reviewers, this pull request conflicts with the following ones:

  • #14796 (rpc: Pass argument descriptions to RPCHelpMan by MarcoFalke)
  • #14459 (More RPC help description fixes by ch4ot1c)

If you consider this pull request important, please also help to review the conflicting pull requests. Ideally, start with the one that should be merged first.

@MarcoFalke MarcoFalke added the Docs label Nov 26, 2018

@@ -939,7 +939,7 @@ static UniValue signrawtransactionwithkey(const JSONRPCRequest& request)
"this transaction depends on but may not yet be in the block chain.\n",
{
{"hexstring", RPCArg::Type::STR, false},
{"privkyes", RPCArg::Type::ARR,
{"privkeys", RPCArg::Type::ARR,

This comment has been minimized.

Copy link
@MarcoFalke

MarcoFalke Nov 26, 2018

Member

Good catch. Currently the argument names of arrays are not used in any way to produce the string by RPCHelpMan, only after #14796.

@MarcoFalke MarcoFalke changed the title clarify RPC rawtransaction documentation doc: clarify RPC rawtransaction documentation Nov 26, 2018

@MarcoFalke MarcoFalke merged commit 848077f into bitcoin:master Nov 26, 2018

2 checks passed

continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details

MarcoFalke added a commit that referenced this pull request Nov 26, 2018

Merge #14808: doc: clarify RPC rawtransaction documentation
848077f clarify RPC rawtransaction documentation (Jameson Lopp)

Pull request description:

  Fixing an RPC documentation typo and clarifying the wording of the testmempoolaccept function.

Tree-SHA512: 495c05ba322d0747ff569d02f5d2ad7d94b5542049c82091f5e74d8d02a8af408f31e10b112ca20d506125e3b39703ec3169f3a446f09ecae3cd46148ffc4041

@jlopp jlopp deleted the jlopp:RPCHelpTypo branch Nov 26, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.