Skip to content

Commit

Permalink
Add backticks to rustdocs
Browse files Browse the repository at this point in the history 
We have square brackets in two places that are confusing the rustdocs
build

1. In a docs string from Core
2. We are abusing markdown list syntax to indicate the stage of dev

For both add backticks. All the ones added because of (2) will go away
shortly (TM).
  • Loading branch information
@tcharding
tcharding committed Nov 25, 2024
1 parent 78a8026 commit 72987d9
Show file tree
Hide file tree
Showing 3 changed files with 259 additions and 257 deletions.
255 changes: 128 additions & 127 deletions types/src/v17/mod.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,151 +16,152 @@
//! - Method does not return anything.
//! - Method returns a simple type (e.g. bool or integer).
//! - Method is deprecated.
// TODO: After all the `[i]` is gone (ie testing done) remove the backticks.
//!
//! **== Blockchain ==**
//! - [x] `getbestblockhash`
//! - [x] `getblock "blockhash" ( verbosity ) `
//! - [x] `getblockchaininfo`
//! - [x] `getblockcount`
//! - [x] `getblockhash height`
//! - [x] `getblockheader "hash" ( verbose )`
//! - [x] `getblockstats hash_or_height ( stats )`
//! - [x] `getchaintips`
//! - [x] `getchaintxstats ( nblocks blockhash )`
//! - [x] `getdifficulty`
//! - [i] `getmempoolancestors txid (verbose)`
//! - [i] `getmempooldescendants txid (verbose)`
//! - [i] `getmempoolentry txid`
//! - [i] `getmempoolinfo`
//! - [i] `getrawmempool ( verbose )`
//! - [i] `gettxout "txid" n ( include_mempool )`
//! - [i] `gettxoutproof ["txid",...] ( blockhash )`
//! - [i] `gettxoutsetinfo`
//! - [-] `preciousblock "blockhash"`
//! - [-] `pruneblockchain`
//! - [-] `savemempool`
//! - [-] `scantxoutset <action> ( <scanobjects> )`
//! - [-] `verifychain ( checklevel nblocks )`
//! - [i] `verifytxoutproof "proof"`
//! - `[x]` `getbestblockhash`
//! - `[x]` `getblock "blockhash" ( verbosity ) `
//! - `[x]` `getblockchaininfo`
//! - `[x]` `getblockcount`
//! - `[x]` `getblockhash height`
//! - `[x]` `getblockheader "hash" ( verbose )`
//! - `[x]` `getblockstats hash_or_height ( stats )`
//! - `[x]` `getchaintips`
//! - `[x]` `getchaintxstats ( nblocks blockhash )`
//! - `[x]` `getdifficulty`
//! - `[i]` `getmempoolancestors txid (verbose)`
//! - `[i]` `getmempooldescendants txid (verbose)`
//! - `[i]` `getmempoolentry txid`
//! - `[i]` `getmempoolinfo`
//! - `[i]` `getrawmempool ( verbose )`
//! - `[i]` `gettxout "txid" n ( include_mempool )`
//! - `[i]` `gettxoutproof ["txid",...] ( blockhash )`
//! - `[i]` `gettxoutsetinfo`
//! - `[-]` `preciousblock "blockhash"`
//! - `[-]` `pruneblockchain`
//! - `[-]` `savemempool`
//! - `[-]` `scantxoutset <action> ( <scanobjects> )`
//! - `[-]` `verifychain ( checklevel nblocks )`
//! - `[i]` `verifytxoutproof "proof"`
//!
//! **== Control ==**
//! - [x] `getmemoryinfo ("mode")`
//! - [-] `help ( "command" )`
//! - [x] `logging ( <include> <exclude> )`
//! - [x] `stop`
//! - [x] `uptime`
//! - `[x]` `getmemoryinfo ("mode")`
//! - `[-]` `help ( "command" )`
//! - `[x]` `logging ( <include> <exclude> )`
//! - `[x]` `stop`
//! - `[x]` `uptime`
//!
//! **== Generating ==**
//! - [x] `generate nblocks ( maxtries )`
//! - [x] `generatetoaddress nblocks address (maxtries)`
//! - `[x]` `generate nblocks ( maxtries )`
//! - `[x]` `generatetoaddress nblocks address (maxtries)`
//!
//! **== Mining ==**
//! - [ ] `getblocktemplate ( TemplateRequest )`
//! - [ ] `getmininginfo`
//! - [ ] `getnetworkhashps ( nblocks height )`
//! - [ ] `prioritisetransaction <txid> <dummy value> <fee delta>`
//! - [ ] `submitblock "hexdata" ( "dummy" )`
//! - `[ ]` `getblocktemplate ( TemplateRequest )`
//! - `[ ]` `getmininginfo`
//! - `[ ]` `getnetworkhashps ( nblocks height )`
//! - `[ ]` `prioritisetransaction <txid> <dummy value> <fee delta>`
//! - `[ ]` `submitblock "hexdata" ( "dummy" )`
//!
//! **== Network ==**
//! - [-] `addnode "node" "add|remove|onetry"`
//! - [-] `clearbanned`
//! - [-] `disconnectnode "[address]" [nodeid]`
//! - [x] `getaddednodeinfo ( "node" )`
//! - [-] `getconnectioncount`
//! - [x] `getnettotals`
//! - [x] `getnetworkinfo`
//! - [x] `getpeerinfo`
//! - [-] `listbanned`
//! - [-] `ping`
//! - [-] `setban "subnet" "add|remove" (bantime) (absolute)`
//! - [-] `setnetworkactive true|false`
//! - `[-]` `addnode "node" "add|remove|onetry"`
//! - `[-]` `clearbanned`
//! - `[-]` `disconnectnode "[address]" [nodeid]`
//! - `[x]` `getaddednodeinfo ( "node" )`
//! - `[-]` `getconnectioncount`
//! - `[x]` `getnettotals`
//! - `[x]` `getnetworkinfo`
//! - `[x]` `getpeerinfo`
//! - `[-]` `listbanned`
//! - `[-]` `ping`
//! - `[-]` `setban "subnet" "add|remove" (bantime) (absolute)`
//! - `[-]` `setnetworkactive true|false`
//!
//! **== Rawtransactions ==**
//! - [ ] `combinepsbt ["psbt",...]`
//! - [ ] `combinerawtransaction ["hexstring",...]`
//! - [ ] `converttopsbt "hexstring" ( permitsigdata iswitness )`
//! - [ ] `createpsbt [{"txid":"id","vout":n},...] [{"address":amount},{"data":"hex"},...] ( locktime ) ( replaceable )`
//! - [ ] `createrawtransaction [{"txid":"id","vout":n},...] [{"address":amount},{"data":"hex"},...] ( locktime ) ( replaceable )`
//! - [ ] `decodepsbt "psbt"`
//! - [ ] `decoderawtransaction "hexstring" ( iswitness )`
//! - [ ] `decodescript "hexstring"`
//! - [ ] `finalizepsbt "psbt" ( extract )`
//! - [ ] `fundrawtransaction "hexstring" ( options iswitness )`
//! - [ ] `getrawtransaction "txid" ( verbose "blockhash" )`
//! - [i] `sendrawtransaction "hexstring" ( allowhighfees )`
//! - [ ] `signrawtransaction "hexstring" ( [{"txid":"id","vout":n,"scriptPubKey":"hex","redeemScript":"hex"},...] ["privatekey1",...] sighashtype )`
//! - [ ] `signrawtransactionwithkey "hexstring" ["privatekey1",...] ( [{"txid":"id","vout":n,"scriptPubKey":"hex","redeemScript":"hex"},...] sighashtype )`
//! - [ ] `testmempoolaccept ["rawtxs"] ( allowhighfees )`
//! - `[ ]` `combinepsbt ["psbt",...]`
//! - `[ ]` `combinerawtransaction ["hexstring",...]`
//! - `[ ]` `converttopsbt "hexstring" ( permitsigdata iswitness )`
//! - `[ ]` `createpsbt [{"txid":"id","vout":n},...] [{"address":amount},{"data":"hex"},...] ( locktime ) ( replaceable )`
//! - `[ ]` `createrawtransaction [{"txid":"id","vout":n},...] [{"address":amount},{"data":"hex"},...] ( locktime ) ( replaceable )`
//! - `[ ]` `decodepsbt "psbt"`
//! - `[ ]` `decoderawtransaction "hexstring" ( iswitness )`
//! - `[ ]` `decodescript "hexstring"`
//! - `[ ]` `finalizepsbt "psbt" ( extract )`
//! - `[ ]` `fundrawtransaction "hexstring" ( options iswitness )`
//! - `[ ]` `getrawtransaction "txid" ( verbose "blockhash" )`
//! - `[i]` `sendrawtransaction "hexstring" ( allowhighfees )`
//! - `[ ]` `signrawtransaction "hexstring" ( [{"txid":"id","vout":n,"scriptPubKey":"hex","redeemScript":"hex"},...] ["privatekey1",...] sighashtype )`
//! - `[ ]` `signrawtransactionwithkey "hexstring" ["privatekey1",...] ( [{"txid":"id","vout":n,"scriptPubKey":"hex","redeemScript":"hex"},...] sighashtype )`
//! - `[ ]` `testmempoolaccept ["rawtxs"] ( allowhighfees )`
//!
//! **== Util ==**
//! - [ ] `createmultisig nrequired ["key",...] ( "address_type" )`
//! - [ ] `estimatesmartfee conf_target ("estimate_mode")`
//! - [ ] `signmessagewithprivkey "privkey" "message"`
//! - [ ] `validateaddress "address"`
//! - [ ] `verifymessage "address" "signature" "message"`
//! - `[ ]` `createmultisig nrequired ["key",...] ( "address_type" )`
//! - `[ ]` `estimatesmartfee conf_target ("estimate_mode")`
//! - `[ ]` `signmessagewithprivkey "privkey" "message"`
//! - `[ ]` `validateaddress "address"`
//! - `[ ]` `verifymessage "address" "signature" "message"`
//!
//! **== Wallet ==**
//! - [-] `abandontransaction "txid"`
//! - [-] `abortrescan`
//! - [x] `addmultisigaddress nrequired ["key",...] ( "label" "address_type" )`
//! - [-] `backupwallet "destination"`
//! - [x] `bumpfee "txid" ( options ) `
//! - [x] `createwallet "wallet_name" ( disable_private_keys )`
//! - [x] `dumpprivkey "address"`
//! - [x] `dumpwallet "filename"`
//! - [-] `encryptwallet "passphrase"`
//! - [-] `getaccount (Deprecated, will be removed in V0.18. To use this command, start bitcoind with -deprecatedrpc=accounts)`
//! - [-] `getaccountaddress (Deprecated, will be removed in V0.18. To use this command, start bitcoind with -deprecatedrpc=accounts)`
//! - [-] `getaddressbyaccount (Deprecated, will be removed in V0.18. To use this command, start bitcoind with -deprecatedrpc=accounts)`
//! - [x] `getaddressesbylabel "label"`
//! - [x] `getaddressinfo "address"`
//! - [x] `getbalance ( "(dummy)" minconf include_watchonly )`
//! - [x] `getnewaddress ( "label" "address_type" )`
//! - [x] `getrawchangeaddress ( "address_type" )`
//! - [-] `getreceivedbyaccount (Deprecated, will be removed in V0.18. To use this command, start bitcoind with -deprecatedrpc=accounts)`
//! - [i] `getreceivedbyaddress "address" ( minconf )`
//! - [x] `gettransaction "txid" ( include_watchonly )`
//! - [i] `getunconfirmedbalance`
//! - [i] `getwalletinfo`
//! - [-] `importaddress "address" ( "label" rescan p2sh )`
//! - [-] `importmulti "requests" ( "options" )`
//! - [-] `importprivkey "privkey" ( "label" ) ( rescan )`
//! - [-] `importprunedfunds`
//! - [-] `importpubkey "pubkey" ( "label" rescan )`
//! - [-] `importwallet "filename"`
//! - [-] `keypoolrefill ( newsize )`
//! - [-] `listaccounts (Deprecated, will be removed in V0.18. To use this command, start bitcoind with -deprecatedrpc=accounts)`
//! - [i] `listaddressgroupings`
//! - [i] `listlabels ( "purpose" )`
//! - [i] `listlockunspent`
//! - [-] `listreceivedbyaccount (Deprecated, will be removed in V0.18. To use this command, start bitcoind with -deprecatedrpc=accounts)`
//! - [i] `listreceivedbyaddress ( minconf include_empty include_watchonly address_filter )`
//! - [i] `listsinceblock ( "blockhash" target_confirmations include_watchonly include_removed )`
//! - [i] `listtransactions (label count skip include_watchonly)`
//! - [i] `listunspent ( minconf maxconf ["addresses",...] [include_unsafe] [query_options])`
//! - [i] `listwallets`
//! - [x] `loadwallet "filename"`
//! - [-] `lockunspent unlock ([{"txid":"txid","vout":n},...])`
//! - [-] `move (Deprecated, will be removed in V0.18. To use this command, start bitcboind with -deprecatedrpc=accounts)`
//! - [-] `removeprunedfunds "txid"`
//! - [x] `rescanblockchain ("start_height") ("stop_height")`
//! - [-] `sendfrom (Deprecated, will be removed in V0.18. To use this command, start bitcoind with -deprecatedrpc=accounts)`
//! - [i] `sendmany "" {"address":amount,...} ( minconf "comment" ["address",...] replaceable conf_target "estimate_mode")`
//! - [x] `sendtoaddress "address" amount ( "comment" "comment_to" subtractfeefromamount replaceable conf_target "estimate_mode")`
//! - [-] `setaccount (Deprecated, will be removed in V0.18. To use this command, start bitcoind with -deprecatedrpc=accounts)`
//! - [-] `sethdseed ( "newkeypool" "seed" )`
//! - [-] `settxfee amount`
//! - [i] `signmessage "address" "message"`
//! - [i] `signrawtransactionwithwallet "hexstring" ( [{"txid":"id","vout":n,"scriptPubKey":"hex","redeemScript":"hex"},...] sighashtype )`
//! - [-] `unloadwallet ( "wallet_name" )`
//! - [i] `walletcreatefundedpsbt [{"txid":"id","vout":n},...] [{"address":amount},{"data":"hex"},...] ( locktime ) ( replaceable ) ( options bip32derivs )`
//! - [-] `walletlock`
//! - [-] `walletpassphrase "passphrase" timeout`
//! - [-] `walletpassphrasechange "oldpassphrase" "newpassphrase"`
//! - [i] `walletprocesspsbt "psbt" ( sign "sighashtype" bip32derivs )`
//! - `[-]` `abandontransaction "txid"`
//! - `[-]` `abortrescan`
//! - `[x]` `addmultisigaddress nrequired ["key",...] ( "label" "address_type" )`
//! - `[-]` `backupwallet "destination"`
//! - `[x]` `bumpfee "txid" ( options ) `
//! - `[x]` `createwallet "wallet_name" ( disable_private_keys )`
//! - `[x]` `dumpprivkey "address"`
//! - `[x]` `dumpwallet "filename"`
//! - `[-]` `encryptwallet "passphrase"`
//! - `[-]` `getaccount (Deprecated, will be removed in V0.18. To use this command, start bitcoind with -deprecatedrpc=accounts)`
//! - `[-]` `getaccountaddress (Deprecated, will be removed in V0.18. To use this command, start bitcoind with -deprecatedrpc=accounts)`
//! - `[-]` `getaddressbyaccount (Deprecated, will be removed in V0.18. To use this command, start bitcoind with -deprecatedrpc=accounts)`
//! - `[x]` `getaddressesbylabel "label"`
//! - `[x]` `getaddressinfo "address"`
//! - `[x]` `getbalance ( "(dummy)" minconf include_watchonly )`
//! - `[x]` `getnewaddress ( "label" "address_type" )`
//! - `[x]` `getrawchangeaddress ( "address_type" )`
//! - `[-]` `getreceivedbyaccount (Deprecated, will be removed in V0.18. To use this command, start bitcoind with -deprecatedrpc=accounts)`
//! - `[i]` `getreceivedbyaddress "address" ( minconf )`
//! - `[x]` `gettransaction "txid" ( include_watchonly )`
//! - `[i]` `getunconfirmedbalance`
//! - `[i]` `getwalletinfo`
//! - `[-]` `importaddress "address" ( "label" rescan p2sh )`
//! - `[-]` `importmulti "requests" ( "options" )`
//! - `[-]` `importprivkey "privkey" ( "label" ) ( rescan )`
//! - `[-]` `importprunedfunds`
//! - `[-]` `importpubkey "pubkey" ( "label" rescan )`
//! - `[-]` `importwallet "filename"`
//! - `[-]` `keypoolrefill ( newsize )`
//! - `[-]` `listaccounts (Deprecated, will be removed in V0.18. To use this command, start bitcoind with -deprecatedrpc=accounts)`
//! - `[i]` `listaddressgroupings`
//! - `[i]` `listlabels ( "purpose" )`
//! - `[i]` `listlockunspent`
//! - `[-]` `listreceivedbyaccount (Deprecated, will be removed in V0.18. To use this command, start bitcoind with -deprecatedrpc=accounts)`
//! - `[i]` `listreceivedbyaddress ( minconf include_empty include_watchonly address_filter )`
//! - `[i]` `listsinceblock ( "blockhash" target_confirmations include_watchonly include_removed )`
//! - `[i]` `listtransactions (label count skip include_watchonly)`
//! - `[i]` `listunspent ( minconf maxconf ["addresses",...] [include_unsafe] [query_options])`
//! - `[i]` `listwallets`
//! - `[x]` `loadwallet "filename"`
//! - `[-]` `lockunspent unlock ([{"txid":"txid","vout":n},...])`
//! - `[-]` `move (Deprecated, will be removed in V0.18. To use this command, start bitcboind with -deprecatedrpc=accounts)`
//! - `[-]` `removeprunedfunds "txid"`
//! - `[x]` `rescanblockchain ("start_height") ("stop_height")`
//! - `[-]` `sendfrom (Deprecated, will be removed in V0.18. To use this command, start bitcoind with -deprecatedrpc=accounts)`
//! - `[i]` `sendmany "" {"address":amount,...} ( minconf "comment" ["address",...] replaceable conf_target "estimate_mode")`
//! - `[x]` `sendtoaddress "address" amount ( "comment" "comment_to" subtractfeefromamount replaceable conf_target "estimate_mode")`
//! - `[-]` `setaccount (Deprecated, will be removed in V0.18. To use this command, start bitcoind with -deprecatedrpc=accounts)`
//! - `[-]` `sethdseed ( "newkeypool" "seed" )`
//! - `[-]` `settxfee amount`
//! - `[i]` `signmessage "address" "message"`
//! - `[i]` `signrawtransactionwithwallet "hexstring" ( [{"txid":"id","vout":n,"scriptPubKey":"hex","redeemScript":"hex"},...] sighashtype )`
//! - `[-]` `unloadwallet ( "wallet_name" )`
//! - `[i]` `walletcreatefundedpsbt [{"txid":"id","vout":n},...] [{"address":amount},{"data":"hex"},...] ( locktime ) ( replaceable ) ( options bip32derivs )`
//! - `[-]` `walletlock`
//! - `[-]` `walletpassphrase "passphrase" timeout`
//! - `[-]` `walletpassphrasechange "oldpassphrase" "newpassphrase"`
//! - `[i]` `walletprocesspsbt "psbt" ( sign "sighashtype" bip32derivs )`
//!
//! **== Zmq ==**
//! - [i] `getzmqnotifications`
//! - `[i]` `getzmqnotifications`
// JSON-RPC types by API section.
mod blockchain;
Expand Down
2 changes: 1 addition & 1 deletion types/src/v17/wallet/mod.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -750,7 +750,7 @@ pub struct ListTransactionsItem {

/// Result of the JSON-RPC method `listunspent`.
///
/// > listunspent ( minconf maxconf ["addresses",...] [include_unsafe] [query_options])
/// > listunspent ( minconf maxconf ["addresses",...] `[include_unsafe]` `[query_options]`)
/// >
/// > Returns array of unspent transaction outputs
/// > with between minconf and maxconf (inclusive) confirmations.
Expand Down
Loading

0 comments on commit 72987d9

Please sign in to comment.