Merged
Conversation
maflcko
force-pushed
the
1912-rpcDocFixes
branch
from
fa1c19c to
fa23513
Compare
Contributor
|
The following sections might be updated with supplementary metadata relevant to reviewers and maintainers. ConflictsNo conflicts as of last run. |
maflcko
force-pushed
the
1912-rpcDocFixes
branch
from
fa23513 to
facaa78
Compare
Contributor
|
Concept ACK: nice cleanups! |
maflcko
force-pushed
the
1912-rpcDocFixes
branch
from
facaa78 to
fa8f302
Compare
kristapsk
reviewed
Dec 27, 2019
src/rpc/blockchain.cpp
Outdated
Contributor
There was a problem hiding this comment.
Maybe change "xxxx" to "true|false" here and elsewhere where it's boolean too, as it is in other places?
src/rpc/blockchain.cpp
Outdated
Contributor
There was a problem hiding this comment.
Numeric uses "n" for numbers and "ttt" for timestamps in other places, maybe change others too instead of "xxx"?
Member
Author
There was a problem hiding this comment.
Actually, most of the times are denoted with xxx, not ttt. Anyway, this is fixed in #17809
Contributor
There was a problem hiding this comment.
Out of curiosity, why is xxxxxx (as well the other "values") necessary? Isn't the type sufficient?
Member
Author
There was a problem hiding this comment.
It serves a placeholder for the value in the key-value pair of a json dict
promag
reviewed
Dec 27, 2019
src/rpc/mining.cpp
Outdated
Member
Author
There was a problem hiding this comment.
Yes, RPC arguments are called this way. Also, most of the RPC results are called this way. This scripted diff adjusts the remaining ones. After #17809 it can be changed to something else with a one-line patch.
Contributor
|
ACK fa8f302c6354bb41c2e7cbdb3448cc1b91c9a531 Reviewed code and did some selective testing. |
maflcko
force-pushed
the
1912-rpcDocFixes
branch
from
fa8f302 to
f9a61c7
Compare
Member
Author
|
Rebased due to conflict in scripted-diff. Should be easy to re-ACK |
added 6 commits
January 23, 2020 10:19
Also, use multi-line for arrays and objects
…orkinfo Also, fix indentation of some fields
Also, properly document all (json object) and (json array)
maflcko
force-pushed
the
1912-rpcDocFixes
branch
from
f9a61c7 to
fabf451
Compare
Contributor
Are they generated automatically? If so how? |
Member
Author
https://github.com/bitcoin-core/bitcoincore.org/tree/master/contrib#rpc-documentation-generation |
maflcko
force-pushed
the
1912-rpcDocFixes
branch
from
fabf451 to
fa5c662
Compare
Member
Author
|
Resolved merge conflict |
Member
|
ACK fa5c662 |
laanwj
added a commit
that referenced
this pull request
Feb 5, 2020
fa5c662 doc: Use proper RPC help syntax in importmulti (MarcoFalke) fab6311 doc: Remove duplicate "comment" from listsinceblock RPC help (MarcoFalke) fa04cd6 doc: Properly document proxy_randomize_credentials as bool in getnetworkinfo (MarcoFalke) fa9dec7 doc: Fix syntax error (trailing square bracket) in finalizepsbt (MarcoFalke) faff5a6 doc: Fix syntax error (trailing square bracket) in walletprocesspsbt (MarcoFalke) fa05459 doc: Add missing "optional" to "long" estimaterawfee RPC help (MarcoFalke) Pull request description: This fixes documentation of the following RPCs: * estimaterawfee (hidden) * https://bitcoincore.org/en/doc/0.19.0/rpc/wallet/walletprocesspsbt/ * https://bitcoincore.org/en/doc/0.19.0/rpc/rawtransactions/finalizepsbt/ * https://bitcoincore.org/en/doc/0.19.0/rpc/network/getnetworkinfo/ * https://bitcoincore.org/en/doc/0.19.0/rpc/wallet/listsinceblock/ * https://bitcoincore.org/en/doc/0.19.0/rpc/wallet/importmulti/ <!-- Also, it comes with a scripted diff to normalize whitespace and type names. (Previous attempts: #14601 and #14459) ACKs for top commit: laanwj: ACK fa5c662 Tree-SHA512: 5a10956e12f8ce23e93a2ce8bafd6cae759d8a21658f79397e3bfce3e4aabd9658bdbd40acde49323dca958a9befee7166654994208c182dd60f483109621e17
sidhujag
pushed a commit
to syscoin/syscoin
that referenced
this pull request
Feb 9, 2020
fa5c662 doc: Use proper RPC help syntax in importmulti (MarcoFalke) fab6311 doc: Remove duplicate "comment" from listsinceblock RPC help (MarcoFalke) fa04cd6 doc: Properly document proxy_randomize_credentials as bool in getnetworkinfo (MarcoFalke) fa9dec7 doc: Fix syntax error (trailing square bracket) in finalizepsbt (MarcoFalke) faff5a6 doc: Fix syntax error (trailing square bracket) in walletprocesspsbt (MarcoFalke) fa05459 doc: Add missing "optional" to "long" estimaterawfee RPC help (MarcoFalke) Pull request description: This fixes documentation of the following RPCs: * estimaterawfee (hidden) * https://bitcoincore.org/en/doc/0.19.0/rpc/wallet/walletprocesspsbt/ * https://bitcoincore.org/en/doc/0.19.0/rpc/rawtransactions/finalizepsbt/ * https://bitcoincore.org/en/doc/0.19.0/rpc/network/getnetworkinfo/ * https://bitcoincore.org/en/doc/0.19.0/rpc/wallet/listsinceblock/ * https://bitcoincore.org/en/doc/0.19.0/rpc/wallet/importmulti/ <!-- Also, it comes with a scripted diff to normalize whitespace and type names. (Previous attempts: bitcoin#14601 and bitcoin#14459) ACKs for top commit: laanwj: ACK fa5c662 Tree-SHA512: 5a10956e12f8ce23e93a2ce8bafd6cae759d8a21658f79397e3bfce3e4aabd9658bdbd40acde49323dca958a9befee7166654994208c182dd60f483109621e17
sidhujag
pushed a commit
to syscoin-core/syscoin
that referenced
this pull request
Nov 10, 2020
fa5c662 doc: Use proper RPC help syntax in importmulti (MarcoFalke) fab6311 doc: Remove duplicate "comment" from listsinceblock RPC help (MarcoFalke) fa04cd6 doc: Properly document proxy_randomize_credentials as bool in getnetworkinfo (MarcoFalke) fa9dec7 doc: Fix syntax error (trailing square bracket) in finalizepsbt (MarcoFalke) faff5a6 doc: Fix syntax error (trailing square bracket) in walletprocesspsbt (MarcoFalke) fa05459 doc: Add missing "optional" to "long" estimaterawfee RPC help (MarcoFalke) Pull request description: This fixes documentation of the following RPCs: * estimaterawfee (hidden) * https://bitcoincore.org/en/doc/0.19.0/rpc/wallet/walletprocesspsbt/ * https://bitcoincore.org/en/doc/0.19.0/rpc/rawtransactions/finalizepsbt/ * https://bitcoincore.org/en/doc/0.19.0/rpc/network/getnetworkinfo/ * https://bitcoincore.org/en/doc/0.19.0/rpc/wallet/listsinceblock/ * https://bitcoincore.org/en/doc/0.19.0/rpc/wallet/importmulti/ <!-- Also, it comes with a scripted diff to normalize whitespace and type names. (Previous attempts: bitcoin#14601 and bitcoin#14459) ACKs for top commit: laanwj: ACK fa5c662 Tree-SHA512: 5a10956e12f8ce23e93a2ce8bafd6cae759d8a21658f79397e3bfce3e4aabd9658bdbd40acde49323dca958a9befee7166654994208c182dd60f483109621e17
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
9 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This fixes documentation of the following RPCs: