Skip to content

Commit 72987d9

Browse files
committed
Add backticks to rustdocs
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).
1 parent 78a8026 commit 72987d9

File tree

3 files changed

+259
-257
lines changed

3 files changed

+259
-257
lines changed

types/src/v17/mod.rs

Lines changed: 128 additions & 127 deletions
Original file line numberDiff line numberDiff line change
@@ -16,151 +16,152 @@
1616
//! - Method does not return anything.
1717
//! - Method returns a simple type (e.g. bool or integer).
1818
//! - Method is deprecated.
19+
// TODO: After all the `[i]` is gone (ie testing done) remove the backticks.
1920
//!
2021
//! **== Blockchain ==**
21-
//! - [x] `getbestblockhash`
22-
//! - [x] `getblock "blockhash" ( verbosity ) `
23-
//! - [x] `getblockchaininfo`
24-
//! - [x] `getblockcount`
25-
//! - [x] `getblockhash height`
26-
//! - [x] `getblockheader "hash" ( verbose )`
27-
//! - [x] `getblockstats hash_or_height ( stats )`
28-
//! - [x] `getchaintips`
29-
//! - [x] `getchaintxstats ( nblocks blockhash )`
30-
//! - [x] `getdifficulty`
31-
//! - [i] `getmempoolancestors txid (verbose)`
32-
//! - [i] `getmempooldescendants txid (verbose)`
33-
//! - [i] `getmempoolentry txid`
34-
//! - [i] `getmempoolinfo`
35-
//! - [i] `getrawmempool ( verbose )`
36-
//! - [i] `gettxout "txid" n ( include_mempool )`
37-
//! - [i] `gettxoutproof ["txid",...] ( blockhash )`
38-
//! - [i] `gettxoutsetinfo`
39-
//! - [-] `preciousblock "blockhash"`
40-
//! - [-] `pruneblockchain`
41-
//! - [-] `savemempool`
42-
//! - [-] `scantxoutset <action> ( <scanobjects> )`
43-
//! - [-] `verifychain ( checklevel nblocks )`
44-
//! - [i] `verifytxoutproof "proof"`
22+
//! - `[x]` `getbestblockhash`
23+
//! - `[x]` `getblock "blockhash" ( verbosity ) `
24+
//! - `[x]` `getblockchaininfo`
25+
//! - `[x]` `getblockcount`
26+
//! - `[x]` `getblockhash height`
27+
//! - `[x]` `getblockheader "hash" ( verbose )`
28+
//! - `[x]` `getblockstats hash_or_height ( stats )`
29+
//! - `[x]` `getchaintips`
30+
//! - `[x]` `getchaintxstats ( nblocks blockhash )`
31+
//! - `[x]` `getdifficulty`
32+
//! - `[i]` `getmempoolancestors txid (verbose)`
33+
//! - `[i]` `getmempooldescendants txid (verbose)`
34+
//! - `[i]` `getmempoolentry txid`
35+
//! - `[i]` `getmempoolinfo`
36+
//! - `[i]` `getrawmempool ( verbose )`
37+
//! - `[i]` `gettxout "txid" n ( include_mempool )`
38+
//! - `[i]` `gettxoutproof ["txid",...] ( blockhash )`
39+
//! - `[i]` `gettxoutsetinfo`
40+
//! - `[-]` `preciousblock "blockhash"`
41+
//! - `[-]` `pruneblockchain`
42+
//! - `[-]` `savemempool`
43+
//! - `[-]` `scantxoutset <action> ( <scanobjects> )`
44+
//! - `[-]` `verifychain ( checklevel nblocks )`
45+
//! - `[i]` `verifytxoutproof "proof"`
4546
//!
4647
//! **== Control ==**
47-
//! - [x] `getmemoryinfo ("mode")`
48-
//! - [-] `help ( "command" )`
49-
//! - [x] `logging ( <include> <exclude> )`
50-
//! - [x] `stop`
51-
//! - [x] `uptime`
48+
//! - `[x]` `getmemoryinfo ("mode")`
49+
//! - `[-]` `help ( "command" )`
50+
//! - `[x]` `logging ( <include> <exclude> )`
51+
//! - `[x]` `stop`
52+
//! - `[x]` `uptime`
5253
//!
5354
//! **== Generating ==**
54-
//! - [x] `generate nblocks ( maxtries )`
55-
//! - [x] `generatetoaddress nblocks address (maxtries)`
55+
//! - `[x]` `generate nblocks ( maxtries )`
56+
//! - `[x]` `generatetoaddress nblocks address (maxtries)`
5657
//!
5758
//! **== Mining ==**
58-
//! - [ ] `getblocktemplate ( TemplateRequest )`
59-
//! - [ ] `getmininginfo`
60-
//! - [ ] `getnetworkhashps ( nblocks height )`
61-
//! - [ ] `prioritisetransaction <txid> <dummy value> <fee delta>`
62-
//! - [ ] `submitblock "hexdata" ( "dummy" )`
59+
//! - `[ ]` `getblocktemplate ( TemplateRequest )`
60+
//! - `[ ]` `getmininginfo`
61+
//! - `[ ]` `getnetworkhashps ( nblocks height )`
62+
//! - `[ ]` `prioritisetransaction <txid> <dummy value> <fee delta>`
63+
//! - `[ ]` `submitblock "hexdata" ( "dummy" )`
6364
//!
6465
//! **== Network ==**
65-
//! - [-] `addnode "node" "add|remove|onetry"`
66-
//! - [-] `clearbanned`
67-
//! - [-] `disconnectnode "[address]" [nodeid]`
68-
//! - [x] `getaddednodeinfo ( "node" )`
69-
//! - [-] `getconnectioncount`
70-
//! - [x] `getnettotals`
71-
//! - [x] `getnetworkinfo`
72-
//! - [x] `getpeerinfo`
73-
//! - [-] `listbanned`
74-
//! - [-] `ping`
75-
//! - [-] `setban "subnet" "add|remove" (bantime) (absolute)`
76-
//! - [-] `setnetworkactive true|false`
66+
//! - `[-]` `addnode "node" "add|remove|onetry"`
67+
//! - `[-]` `clearbanned`
68+
//! - `[-]` `disconnectnode "[address]" [nodeid]`
69+
//! - `[x]` `getaddednodeinfo ( "node" )`
70+
//! - `[-]` `getconnectioncount`
71+
//! - `[x]` `getnettotals`
72+
//! - `[x]` `getnetworkinfo`
73+
//! - `[x]` `getpeerinfo`
74+
//! - `[-]` `listbanned`
75+
//! - `[-]` `ping`
76+
//! - `[-]` `setban "subnet" "add|remove" (bantime) (absolute)`
77+
//! - `[-]` `setnetworkactive true|false`
7778
//!
7879
//! **== Rawtransactions ==**
79-
//! - [ ] `combinepsbt ["psbt",...]`
80-
//! - [ ] `combinerawtransaction ["hexstring",...]`
81-
//! - [ ] `converttopsbt "hexstring" ( permitsigdata iswitness )`
82-
//! - [ ] `createpsbt [{"txid":"id","vout":n},...] [{"address":amount},{"data":"hex"},...] ( locktime ) ( replaceable )`
83-
//! - [ ] `createrawtransaction [{"txid":"id","vout":n},...] [{"address":amount},{"data":"hex"},...] ( locktime ) ( replaceable )`
84-
//! - [ ] `decodepsbt "psbt"`
85-
//! - [ ] `decoderawtransaction "hexstring" ( iswitness )`
86-
//! - [ ] `decodescript "hexstring"`
87-
//! - [ ] `finalizepsbt "psbt" ( extract )`
88-
//! - [ ] `fundrawtransaction "hexstring" ( options iswitness )`
89-
//! - [ ] `getrawtransaction "txid" ( verbose "blockhash" )`
90-
//! - [i] `sendrawtransaction "hexstring" ( allowhighfees )`
91-
//! - [ ] `signrawtransaction "hexstring" ( [{"txid":"id","vout":n,"scriptPubKey":"hex","redeemScript":"hex"},...] ["privatekey1",...] sighashtype )`
92-
//! - [ ] `signrawtransactionwithkey "hexstring" ["privatekey1",...] ( [{"txid":"id","vout":n,"scriptPubKey":"hex","redeemScript":"hex"},...] sighashtype )`
93-
//! - [ ] `testmempoolaccept ["rawtxs"] ( allowhighfees )`
80+
//! - `[ ]` `combinepsbt ["psbt",...]`
81+
//! - `[ ]` `combinerawtransaction ["hexstring",...]`
82+
//! - `[ ]` `converttopsbt "hexstring" ( permitsigdata iswitness )`
83+
//! - `[ ]` `createpsbt [{"txid":"id","vout":n},...] [{"address":amount},{"data":"hex"},...] ( locktime ) ( replaceable )`
84+
//! - `[ ]` `createrawtransaction [{"txid":"id","vout":n},...] [{"address":amount},{"data":"hex"},...] ( locktime ) ( replaceable )`
85+
//! - `[ ]` `decodepsbt "psbt"`
86+
//! - `[ ]` `decoderawtransaction "hexstring" ( iswitness )`
87+
//! - `[ ]` `decodescript "hexstring"`
88+
//! - `[ ]` `finalizepsbt "psbt" ( extract )`
89+
//! - `[ ]` `fundrawtransaction "hexstring" ( options iswitness )`
90+
//! - `[ ]` `getrawtransaction "txid" ( verbose "blockhash" )`
91+
//! - `[i]` `sendrawtransaction "hexstring" ( allowhighfees )`
92+
//! - `[ ]` `signrawtransaction "hexstring" ( [{"txid":"id","vout":n,"scriptPubKey":"hex","redeemScript":"hex"},...] ["privatekey1",...] sighashtype )`
93+
//! - `[ ]` `signrawtransactionwithkey "hexstring" ["privatekey1",...] ( [{"txid":"id","vout":n,"scriptPubKey":"hex","redeemScript":"hex"},...] sighashtype )`
94+
//! - `[ ]` `testmempoolaccept ["rawtxs"] ( allowhighfees )`
9495
//!
9596
//! **== Util ==**
96-
//! - [ ] `createmultisig nrequired ["key",...] ( "address_type" )`
97-
//! - [ ] `estimatesmartfee conf_target ("estimate_mode")`
98-
//! - [ ] `signmessagewithprivkey "privkey" "message"`
99-
//! - [ ] `validateaddress "address"`
100-
//! - [ ] `verifymessage "address" "signature" "message"`
97+
//! - `[ ]` `createmultisig nrequired ["key",...] ( "address_type" )`
98+
//! - `[ ]` `estimatesmartfee conf_target ("estimate_mode")`
99+
//! - `[ ]` `signmessagewithprivkey "privkey" "message"`
100+
//! - `[ ]` `validateaddress "address"`
101+
//! - `[ ]` `verifymessage "address" "signature" "message"`
101102
//!
102103
//! **== Wallet ==**
103-
//! - [-] `abandontransaction "txid"`
104-
//! - [-] `abortrescan`
105-
//! - [x] `addmultisigaddress nrequired ["key",...] ( "label" "address_type" )`
106-
//! - [-] `backupwallet "destination"`
107-
//! - [x] `bumpfee "txid" ( options ) `
108-
//! - [x] `createwallet "wallet_name" ( disable_private_keys )`
109-
//! - [x] `dumpprivkey "address"`
110-
//! - [x] `dumpwallet "filename"`
111-
//! - [-] `encryptwallet "passphrase"`
112-
//! - [-] `getaccount (Deprecated, will be removed in V0.18. To use this command, start bitcoind with -deprecatedrpc=accounts)`
113-
//! - [-] `getaccountaddress (Deprecated, will be removed in V0.18. To use this command, start bitcoind with -deprecatedrpc=accounts)`
114-
//! - [-] `getaddressbyaccount (Deprecated, will be removed in V0.18. To use this command, start bitcoind with -deprecatedrpc=accounts)`
115-
//! - [x] `getaddressesbylabel "label"`
116-
//! - [x] `getaddressinfo "address"`
117-
//! - [x] `getbalance ( "(dummy)" minconf include_watchonly )`
118-
//! - [x] `getnewaddress ( "label" "address_type" )`
119-
//! - [x] `getrawchangeaddress ( "address_type" )`
120-
//! - [-] `getreceivedbyaccount (Deprecated, will be removed in V0.18. To use this command, start bitcoind with -deprecatedrpc=accounts)`
121-
//! - [i] `getreceivedbyaddress "address" ( minconf )`
122-
//! - [x] `gettransaction "txid" ( include_watchonly )`
123-
//! - [i] `getunconfirmedbalance`
124-
//! - [i] `getwalletinfo`
125-
//! - [-] `importaddress "address" ( "label" rescan p2sh )`
126-
//! - [-] `importmulti "requests" ( "options" )`
127-
//! - [-] `importprivkey "privkey" ( "label" ) ( rescan )`
128-
//! - [-] `importprunedfunds`
129-
//! - [-] `importpubkey "pubkey" ( "label" rescan )`
130-
//! - [-] `importwallet "filename"`
131-
//! - [-] `keypoolrefill ( newsize )`
132-
//! - [-] `listaccounts (Deprecated, will be removed in V0.18. To use this command, start bitcoind with -deprecatedrpc=accounts)`
133-
//! - [i] `listaddressgroupings`
134-
//! - [i] `listlabels ( "purpose" )`
135-
//! - [i] `listlockunspent`
136-
//! - [-] `listreceivedbyaccount (Deprecated, will be removed in V0.18. To use this command, start bitcoind with -deprecatedrpc=accounts)`
137-
//! - [i] `listreceivedbyaddress ( minconf include_empty include_watchonly address_filter )`
138-
//! - [i] `listsinceblock ( "blockhash" target_confirmations include_watchonly include_removed )`
139-
//! - [i] `listtransactions (label count skip include_watchonly)`
140-
//! - [i] `listunspent ( minconf maxconf ["addresses",...] [include_unsafe] [query_options])`
141-
//! - [i] `listwallets`
142-
//! - [x] `loadwallet "filename"`
143-
//! - [-] `lockunspent unlock ([{"txid":"txid","vout":n},...])`
144-
//! - [-] `move (Deprecated, will be removed in V0.18. To use this command, start bitcboind with -deprecatedrpc=accounts)`
145-
//! - [-] `removeprunedfunds "txid"`
146-
//! - [x] `rescanblockchain ("start_height") ("stop_height")`
147-
//! - [-] `sendfrom (Deprecated, will be removed in V0.18. To use this command, start bitcoind with -deprecatedrpc=accounts)`
148-
//! - [i] `sendmany "" {"address":amount,...} ( minconf "comment" ["address",...] replaceable conf_target "estimate_mode")`
149-
//! - [x] `sendtoaddress "address" amount ( "comment" "comment_to" subtractfeefromamount replaceable conf_target "estimate_mode")`
150-
//! - [-] `setaccount (Deprecated, will be removed in V0.18. To use this command, start bitcoind with -deprecatedrpc=accounts)`
151-
//! - [-] `sethdseed ( "newkeypool" "seed" )`
152-
//! - [-] `settxfee amount`
153-
//! - [i] `signmessage "address" "message"`
154-
//! - [i] `signrawtransactionwithwallet "hexstring" ( [{"txid":"id","vout":n,"scriptPubKey":"hex","redeemScript":"hex"},...] sighashtype )`
155-
//! - [-] `unloadwallet ( "wallet_name" )`
156-
//! - [i] `walletcreatefundedpsbt [{"txid":"id","vout":n},...] [{"address":amount},{"data":"hex"},...] ( locktime ) ( replaceable ) ( options bip32derivs )`
157-
//! - [-] `walletlock`
158-
//! - [-] `walletpassphrase "passphrase" timeout`
159-
//! - [-] `walletpassphrasechange "oldpassphrase" "newpassphrase"`
160-
//! - [i] `walletprocesspsbt "psbt" ( sign "sighashtype" bip32derivs )`
104+
//! - `[-]` `abandontransaction "txid"`
105+
//! - `[-]` `abortrescan`
106+
//! - `[x]` `addmultisigaddress nrequired ["key",...] ( "label" "address_type" )`
107+
//! - `[-]` `backupwallet "destination"`
108+
//! - `[x]` `bumpfee "txid" ( options ) `
109+
//! - `[x]` `createwallet "wallet_name" ( disable_private_keys )`
110+
//! - `[x]` `dumpprivkey "address"`
111+
//! - `[x]` `dumpwallet "filename"`
112+
//! - `[-]` `encryptwallet "passphrase"`
113+
//! - `[-]` `getaccount (Deprecated, will be removed in V0.18. To use this command, start bitcoind with -deprecatedrpc=accounts)`
114+
//! - `[-]` `getaccountaddress (Deprecated, will be removed in V0.18. To use this command, start bitcoind with -deprecatedrpc=accounts)`
115+
//! - `[-]` `getaddressbyaccount (Deprecated, will be removed in V0.18. To use this command, start bitcoind with -deprecatedrpc=accounts)`
116+
//! - `[x]` `getaddressesbylabel "label"`
117+
//! - `[x]` `getaddressinfo "address"`
118+
//! - `[x]` `getbalance ( "(dummy)" minconf include_watchonly )`
119+
//! - `[x]` `getnewaddress ( "label" "address_type" )`
120+
//! - `[x]` `getrawchangeaddress ( "address_type" )`
121+
//! - `[-]` `getreceivedbyaccount (Deprecated, will be removed in V0.18. To use this command, start bitcoind with -deprecatedrpc=accounts)`
122+
//! - `[i]` `getreceivedbyaddress "address" ( minconf )`
123+
//! - `[x]` `gettransaction "txid" ( include_watchonly )`
124+
//! - `[i]` `getunconfirmedbalance`
125+
//! - `[i]` `getwalletinfo`
126+
//! - `[-]` `importaddress "address" ( "label" rescan p2sh )`
127+
//! - `[-]` `importmulti "requests" ( "options" )`
128+
//! - `[-]` `importprivkey "privkey" ( "label" ) ( rescan )`
129+
//! - `[-]` `importprunedfunds`
130+
//! - `[-]` `importpubkey "pubkey" ( "label" rescan )`
131+
//! - `[-]` `importwallet "filename"`
132+
//! - `[-]` `keypoolrefill ( newsize )`
133+
//! - `[-]` `listaccounts (Deprecated, will be removed in V0.18. To use this command, start bitcoind with -deprecatedrpc=accounts)`
134+
//! - `[i]` `listaddressgroupings`
135+
//! - `[i]` `listlabels ( "purpose" )`
136+
//! - `[i]` `listlockunspent`
137+
//! - `[-]` `listreceivedbyaccount (Deprecated, will be removed in V0.18. To use this command, start bitcoind with -deprecatedrpc=accounts)`
138+
//! - `[i]` `listreceivedbyaddress ( minconf include_empty include_watchonly address_filter )`
139+
//! - `[i]` `listsinceblock ( "blockhash" target_confirmations include_watchonly include_removed )`
140+
//! - `[i]` `listtransactions (label count skip include_watchonly)`
141+
//! - `[i]` `listunspent ( minconf maxconf ["addresses",...] [include_unsafe] [query_options])`
142+
//! - `[i]` `listwallets`
143+
//! - `[x]` `loadwallet "filename"`
144+
//! - `[-]` `lockunspent unlock ([{"txid":"txid","vout":n},...])`
145+
//! - `[-]` `move (Deprecated, will be removed in V0.18. To use this command, start bitcboind with -deprecatedrpc=accounts)`
146+
//! - `[-]` `removeprunedfunds "txid"`
147+
//! - `[x]` `rescanblockchain ("start_height") ("stop_height")`
148+
//! - `[-]` `sendfrom (Deprecated, will be removed in V0.18. To use this command, start bitcoind with -deprecatedrpc=accounts)`
149+
//! - `[i]` `sendmany "" {"address":amount,...} ( minconf "comment" ["address",...] replaceable conf_target "estimate_mode")`
150+
//! - `[x]` `sendtoaddress "address" amount ( "comment" "comment_to" subtractfeefromamount replaceable conf_target "estimate_mode")`
151+
//! - `[-]` `setaccount (Deprecated, will be removed in V0.18. To use this command, start bitcoind with -deprecatedrpc=accounts)`
152+
//! - `[-]` `sethdseed ( "newkeypool" "seed" )`
153+
//! - `[-]` `settxfee amount`
154+
//! - `[i]` `signmessage "address" "message"`
155+
//! - `[i]` `signrawtransactionwithwallet "hexstring" ( [{"txid":"id","vout":n,"scriptPubKey":"hex","redeemScript":"hex"},...] sighashtype )`
156+
//! - `[-]` `unloadwallet ( "wallet_name" )`
157+
//! - `[i]` `walletcreatefundedpsbt [{"txid":"id","vout":n},...] [{"address":amount},{"data":"hex"},...] ( locktime ) ( replaceable ) ( options bip32derivs )`
158+
//! - `[-]` `walletlock`
159+
//! - `[-]` `walletpassphrase "passphrase" timeout`
160+
//! - `[-]` `walletpassphrasechange "oldpassphrase" "newpassphrase"`
161+
//! - `[i]` `walletprocesspsbt "psbt" ( sign "sighashtype" bip32derivs )`
161162
//!
162163
//! **== Zmq ==**
163-
//! - [i] `getzmqnotifications`
164+
//! - `[i]` `getzmqnotifications`
164165
165166
// JSON-RPC types by API section.
166167
mod blockchain;

types/src/v17/wallet/mod.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -750,7 +750,7 @@ pub struct ListTransactionsItem {
750750

751751
/// Result of the JSON-RPC method `listunspent`.
752752
///
753-
/// > listunspent ( minconf maxconf ["addresses",...] [include_unsafe] [query_options])
753+
/// > listunspent ( minconf maxconf ["addresses",...] `[include_unsafe]` `[query_options]`)
754754
/// >
755755
/// > Returns array of unspent transaction outputs
756756
/// > with between minconf and maxconf (inclusive) confirmations.

0 commit comments

Comments
 (0)