Skip to content

Commit 4a2d02e

Browse files
jamillambertjamillambert
committed
Add full stops to rustdocs in Client
Use AI to go through every file in client and add missing full stops to the rust docs.
1 parent e71a6b0 commit 4a2d02e

25 files changed

+98
-98
lines changed

‎client/src/client_sync/error.rs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ pub enum Error {
2020
Returned(String),
2121
/// The server version did not match what was expected.
2222
ServerVersion(UnexpectedServerVersionError),
23-
/// Missing user/password
23+
/// Missing user/password.
2424
MissingUserPassword,
2525
}
2626

‎client/src/client_sync/v17/blockchain.rs‎

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
//!
1010
//! See or use the `define_jsonrpc_minreq_client!` macro to define a `Client`.
1111
12-
/// Implements Bitcoin Core JSON-RPC API method `getblockchaininfo`
12+
/// Implements Bitcoin Core JSON-RPC API method `getblockchaininfo`.
1313
#[macro_export]
1414
macro_rules! impl_client_v17__get_blockchain_info {
1515
() => {
@@ -21,7 +21,7 @@ macro_rules! impl_client_v17__get_blockchain_info {
2121
};
2222
}
2323

24-
/// Implements Bitcoin Core JSON-RPC API method `getbestblockhash`
24+
/// Implements Bitcoin Core JSON-RPC API method `getbestblockhash`.
2525
#[macro_export]
2626
macro_rules! impl_client_v17__get_best_block_hash {
2727
() => {
@@ -39,7 +39,7 @@ macro_rules! impl_client_v17__get_best_block_hash {
3939
};
4040
}
4141

42-
/// Implements Bitcoin Core JSON-RPC API method `getblock`
42+
/// Implements Bitcoin Core JSON-RPC API method `getblock`.
4343
#[macro_export]
4444
macro_rules! impl_client_v17__get_block {
4545
() => {
@@ -63,7 +63,7 @@ macro_rules! impl_client_v17__get_block {
6363
};
6464
}
6565

66-
/// Implements Bitcoin Core JSON-RPC API method `getblockcount`
66+
/// Implements Bitcoin Core JSON-RPC API method `getblockcount`.
6767
#[macro_export]
6868
macro_rules! impl_client_v17__get_block_count {
6969
() => {
@@ -75,7 +75,7 @@ macro_rules! impl_client_v17__get_block_count {
7575
};
7676
}
7777

78-
/// Implements Bitcoin Core JSON-RPC API method `getblockhash`
78+
/// Implements Bitcoin Core JSON-RPC API method `getblockhash`.
7979
#[macro_export]
8080
macro_rules! impl_client_v17__get_block_hash {
8181
() => {
@@ -87,7 +87,7 @@ macro_rules! impl_client_v17__get_block_hash {
8787
};
8888
}
8989

90-
/// Implements Bitcoin Core JSON-RPC API method `getblockheader`
90+
/// Implements Bitcoin Core JSON-RPC API method `getblockheader`.
9191
#[macro_export]
9292
macro_rules! impl_client_v17__get_block_header {
9393
() => {
@@ -107,7 +107,7 @@ macro_rules! impl_client_v17__get_block_header {
107107
};
108108
}
109109

110-
/// Implements Bitcoin Core JSON-RPC API method `getblockstats`
110+
/// Implements Bitcoin Core JSON-RPC API method `getblockstats`.
111111
#[macro_export]
112112
macro_rules! impl_client_v17__get_block_stats {
113113
() => {
@@ -123,7 +123,7 @@ macro_rules! impl_client_v17__get_block_stats {
123123
};
124124
}
125125

126-
/// Implements Bitcoin Core JSON-RPC API method `getchaintips`
126+
/// Implements Bitcoin Core JSON-RPC API method `getchaintips`.
127127
#[macro_export]
128128
macro_rules! impl_client_v17__get_chain_tips {
129129
() => {
@@ -133,7 +133,7 @@ macro_rules! impl_client_v17__get_chain_tips {
133133
};
134134
}
135135

136-
/// Implements Bitcoin Core JSON-RPC API method `getchaintxstats`
136+
/// Implements Bitcoin Core JSON-RPC API method `getchaintxstats`.
137137
#[macro_export]
138138
macro_rules! impl_client_v17__get_chain_tx_stats {
139139
() => {
@@ -145,7 +145,7 @@ macro_rules! impl_client_v17__get_chain_tx_stats {
145145
};
146146
}
147147

148-
/// Implements Bitcoin Core JSON-RPC API method `getdifficulty`
148+
/// Implements Bitcoin Core JSON-RPC API method `getdifficulty`.
149149
#[macro_export]
150150
macro_rules! impl_client_v17__get_difficulty {
151151
() => {
@@ -157,7 +157,7 @@ macro_rules! impl_client_v17__get_difficulty {
157157
};
158158
}
159159

160-
/// Implements Bitcoin Core JSON-RPC API method `getmempoolancestors`
160+
/// Implements Bitcoin Core JSON-RPC API method `getmempoolancestors`.
161161
#[macro_export]
162162
macro_rules! impl_client_v17__get_mempool_ancestors {
163163
() => {
@@ -177,7 +177,7 @@ macro_rules! impl_client_v17__get_mempool_ancestors {
177177
};
178178
}
179179

180-
/// Implements Bitcoin Core JSON-RPC API method `getmempooldescendants`
180+
/// Implements Bitcoin Core JSON-RPC API method `getmempooldescendants`.
181181
#[macro_export]
182182
macro_rules! impl_client_v17__get_mempool_descendants {
183183
() => {
@@ -197,7 +197,7 @@ macro_rules! impl_client_v17__get_mempool_descendants {
197197
};
198198
}
199199

200-
/// Implements Bitcoin Core JSON-RPC API method `getmempoolentry`
200+
/// Implements Bitcoin Core JSON-RPC API method `getmempoolentry`.
201201
#[macro_export]
202202
macro_rules! impl_client_v17__get_mempool_entry {
203203
() => {
@@ -209,7 +209,7 @@ macro_rules! impl_client_v17__get_mempool_entry {
209209
};
210210
}
211211

212-
/// Implements Bitcoin Core JSON-RPC API method `getmempoolinfo`
212+
/// Implements Bitcoin Core JSON-RPC API method `getmempoolinfo`.
213213
#[macro_export]
214214
macro_rules! impl_client_v17__get_mempool_info {
215215
() => {
@@ -221,7 +221,7 @@ macro_rules! impl_client_v17__get_mempool_info {
221221
};
222222
}
223223

224-
/// Implements Bitcoin Core JSON-RPC API method `getrawmempool`
224+
/// Implements Bitcoin Core JSON-RPC API method `getrawmempool`.
225225
#[macro_export]
226226
macro_rules! impl_client_v17__get_raw_mempool {
227227
() => {
@@ -237,7 +237,7 @@ macro_rules! impl_client_v17__get_raw_mempool {
237237
};
238238
}
239239

240-
/// Implements Bitcoin Core JSON-RPC API method `gettxout`
240+
/// Implements Bitcoin Core JSON-RPC API method `gettxout`.
241241
#[macro_export]
242242
macro_rules! impl_client_v17__get_tx_out {
243243
() => {
@@ -249,7 +249,7 @@ macro_rules! impl_client_v17__get_tx_out {
249249
};
250250
}
251251

252-
/// Implements Bitcoin Core JSON-RPC API method `gettxoutproof`
252+
/// Implements Bitcoin Core JSON-RPC API method `gettxoutproof`.
253253
#[macro_export]
254254
macro_rules! impl_client_v17__get_tx_out_proof {
255255
() => {
@@ -261,7 +261,7 @@ macro_rules! impl_client_v17__get_tx_out_proof {
261261
};
262262
}
263263

264-
/// Implements Bitcoin Core JSON-RPC API method `gettxoutsetinfo`
264+
/// Implements Bitcoin Core JSON-RPC API method `gettxoutsetinfo`.
265265
#[macro_export]
266266
macro_rules! impl_client_v17__get_tx_out_set_info {
267267
() => {
@@ -273,7 +273,7 @@ macro_rules! impl_client_v17__get_tx_out_set_info {
273273
};
274274
}
275275

276-
/// Implements Bitcoin Core JSON-RPC API method `preciousblock`
276+
/// Implements Bitcoin Core JSON-RPC API method `preciousblock`.
277277
#[macro_export]
278278
macro_rules! impl_client_v17__precious_block {
279279
() => {
@@ -289,7 +289,7 @@ macro_rules! impl_client_v17__precious_block {
289289
};
290290
}
291291

292-
/// Implements Bitcoin Core JSON-RPC API method `pruneblockchain`
292+
/// Implements Bitcoin Core JSON-RPC API method `pruneblockchain`.
293293
#[macro_export]
294294
macro_rules! impl_client_v17__prune_blockchain {
295295
() => {
@@ -302,7 +302,7 @@ macro_rules! impl_client_v17__prune_blockchain {
302302
};
303303
}
304304

305-
/// Implements Bitcoin Core JSON-RPC API method `savemempool`
305+
/// Implements Bitcoin Core JSON-RPC API method `savemempool`.
306306
#[macro_export]
307307
macro_rules! impl_client_v17__save_mempool {
308308
() => {
@@ -318,7 +318,7 @@ macro_rules! impl_client_v17__save_mempool {
318318
};
319319
}
320320

321-
/// Implements Bitcoin Core JSON-RPC API method `verifychain`
321+
/// Implements Bitcoin Core JSON-RPC API method `verifychain`.
322322
#[macro_export]
323323
macro_rules! impl_client_v17__verify_chain {
324324
() => {
@@ -328,7 +328,7 @@ macro_rules! impl_client_v17__verify_chain {
328328
};
329329
}
330330

331-
/// Implements Bitcoin Core JSON-RPC API method `verifytxoutproof`
331+
/// Implements Bitcoin Core JSON-RPC API method `verifytxoutproof`.
332332
#[macro_export]
333333
macro_rules! impl_client_v17__verify_tx_out_proof {
334334
() => {

‎client/src/client_sync/v17/generating.rs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
//!
1010
//! See or use the `define_jsonrpc_minreq_client!` macro to define a `Client`.
1111
12-
/// Implements Bitcoin Core JSON-RPC API method `generatetoaddress`
12+
/// Implements Bitcoin Core JSON-RPC API method `generatetoaddress`.
1313
#[macro_export]
1414
macro_rules! impl_client_v17__generate_to_address {
1515
() => {
@@ -25,7 +25,7 @@ macro_rules! impl_client_v17__generate_to_address {
2525
};
2626
}
2727

28-
/// Implements Bitcoin Core JSON-RPC API method `generate`
28+
/// Implements Bitcoin Core JSON-RPC API method `generate`.
2929
#[macro_export]
3030
macro_rules! impl_client_v17__generate {
3131
() => {
@@ -37,7 +37,7 @@ macro_rules! impl_client_v17__generate {
3737
};
3838
}
3939

40-
/// Implements Bitcoin Core JSON-RPC API method `invalidateblock`
40+
/// Implements Bitcoin Core JSON-RPC API method `invalidateblock`.
4141
// This method does not appear in the output of `bitcoin-cli help`.
4242
#[macro_export]
4343
macro_rules! impl_client_v17__invalidate_block {

‎client/src/client_sync/v17/mining.rs‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
//!
1010
//! See or use the `define_jsonrpc_minreq_client!` macro to define a `Client`.
1111
12-
/// Implements Bitcoin Core JSON-RPC API method `getblocktemplate`
12+
/// Implements Bitcoin Core JSON-RPC API method `getblocktemplate`.
1313
#[macro_export]
1414
macro_rules! impl_client_v17__get_block_template {
1515
() => {
@@ -24,7 +24,7 @@ macro_rules! impl_client_v17__get_block_template {
2424
};
2525
}
2626

27-
/// Implements Bitcoin Core JSON-RPC API method `getmininginfo`
27+
/// Implements Bitcoin Core JSON-RPC API method `getmininginfo`.
2828
#[macro_export]
2929
macro_rules! impl_client_v17__get_mining_info {
3030
() => {
@@ -36,7 +36,7 @@ macro_rules! impl_client_v17__get_mining_info {
3636
};
3737
}
3838

39-
/// Implements Bitcoin Core JSON-RPC API method `getnetworkhashps`
39+
/// Implements Bitcoin Core JSON-RPC API method `getnetworkhashps`.
4040
#[macro_export]
4141
macro_rules! impl_client_v17__get_network_hashes_per_second {
4242
() => {
@@ -46,7 +46,7 @@ macro_rules! impl_client_v17__get_network_hashes_per_second {
4646
};
4747
}
4848

49-
/// Implements Bitcoin Core JSON-RPC API method `prioritisetransaction`
49+
/// Implements Bitcoin Core JSON-RPC API method `prioritisetransaction`.
5050
#[macro_export]
5151
macro_rules! impl_client_v17__prioritise_transaction {
5252
() => {
@@ -63,7 +63,7 @@ macro_rules! impl_client_v17__prioritise_transaction {
6363
};
6464
}
6565

66-
/// Implements Bitcoin Core JSON-RPC API method `submitblock`
66+
/// Implements Bitcoin Core JSON-RPC API method `submitblock`.
6767
#[macro_export]
6868
macro_rules! impl_client_v17__submit_block {
6969
() => {

‎client/src/client_sync/v17/mod.rs‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -241,7 +241,7 @@ pub struct WalletCreateFundedPsbtInput {
241241
vout: u32,
242242
}
243243

244-
/// Args for the `addnode` method
244+
/// Args for the `addnode` method.
245245
#[derive(Clone, Copy, Debug, Deserialize, Serialize)]
246246
#[serde(rename_all = "lowercase")]
247247
pub enum AddNodeCommand {
@@ -250,18 +250,18 @@ pub enum AddNodeCommand {
250250
OneTry,
251251
}
252252

253-
/// Args for the `setban` method
253+
/// Args for the `setban` method.
254254
#[derive(Clone, Copy, Debug, Deserialize, Serialize)]
255255
#[serde(rename_all = "lowercase")]
256256
pub enum SetBanCommand {
257257
Add,
258258
Remove,
259259
}
260260

261-
/// Args for the `importmulti` method
261+
/// Args for the `importmulti` method.
262262
#[derive(Clone, Debug, Deserialize, PartialEq, Serialize)]
263263
pub struct ImportMultiRequest {
264-
/// Descriptor to import. If using descriptor, donot also provide address/scriptPubKey, scripts, or pubkeys.
264+
/// Descriptor to import. If using descriptor, do not also provide address/scriptPubKey, scripts, or pubkeys.
265265
#[serde(rename = "desc", skip_serializing_if = "Option::is_none")]
266266
pub descriptor: Option<String>, // from core v18 onwards.
267267
/// Type of scriptPubKey (string for script, json for address). Should not be provided if using descriptor.
@@ -281,7 +281,7 @@ pub enum ImportMultiScriptPubKey {
281281
Address { address: String },
282282
}
283283

284-
/// `timestamp` can be a number (UNIX epoch time) or the string `"now"`
284+
/// `timestamp` can be a number (UNIX epoch time) or the string `"now"`.
285285
#[derive(Clone, Debug, Deserialize, PartialEq)]
286286
#[serde(untagged)]
287287
pub enum ImportMultiTimestamp {

0 commit comments

Comments
 (0)