Skip to content

Commit a964362

Browse files
committed
Add full stops to rustdocs in types
Use AI to go through every file in types and add missing full stops to the rust docs. Only add to this crates rustdocs not the section `/// >` that comes from core.
1 parent 6f92d18 commit a964362

File tree

7 files changed

+15
-15
lines changed

7 files changed

+15
-15
lines changed

types/src/v17/network/mod.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -273,7 +273,7 @@ pub struct PeerInfo {
273273
#[serde(deny_unknown_fields)]
274274
pub struct ListBanned(pub Vec<Banned>);
275275

276-
/// An item from the list returned by the JSON-RPC method `listbanned`
276+
/// An item from the list returned by the JSON-RPC method `listbanned`.
277277
#[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
278278
#[serde(deny_unknown_fields)]
279279
pub struct Banned {

types/src/v17/wallet/mod.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ pub use self::error::*;
2424
// - ListSinceBlockTransaction
2525
// - ListTransactionsItem
2626

27-
/// Returned as part of `getaddressesbylabel` and `getaddressinfo`
27+
/// Returned as part of `getaddressesbylabel` and `getaddressinfo`.
2828
#[derive(Copy, Clone, PartialEq, Eq, Debug, Deserialize, Serialize)]
2929
#[serde(rename_all = "lowercase")]
3030
pub enum AddressPurpose {

types/src/v20/network.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ use serde::{Deserialize, Serialize};
1515
#[serde(deny_unknown_fields)]
1616
pub struct ListBanned(pub Vec<Banned>);
1717

18-
/// An item from the list returned by the JSON-RPC method `listbanned`
18+
/// An item from the list returned by the JSON-RPC method `listbanned`.
1919
#[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
2020
#[serde(deny_unknown_fields)]
2121
pub struct Banned {

types/src/v22/network.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ use serde::{Deserialize, Serialize};
1717
#[serde(deny_unknown_fields)]
1818
pub struct ListBanned(pub Vec<Banned>);
1919

20-
/// An item from the list returned by the JSON-RPC method `listbanned`
20+
/// An item from the list returned by the JSON-RPC method `listbanned`.
2121
#[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
2222
#[serde(deny_unknown_fields)]
2323
pub struct Banned {

types/src/v28/raw_transactions/mod.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ pub struct SubmitPackageTxResult {
6262
pub vsize: Option<i64>,
6363
/// Transaction fees.
6464
pub fees: Option<SubmitPackageTxResultFees>,
65-
/// The transaction error string, if it was rejected by the mempool
65+
/// The transaction error string, if it was rejected by the mempool.
6666
pub error: Option<String>,
6767
}
6868

types/src/v28/wallet/mod.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ pub struct GetTransaction {
7171
/// If a comment is associated with the transaction, only present if not empty. v20 to v24 only.
7272
pub comment: Option<String>,
7373
/// Whether this transaction could be replaced due to BIP125 (replace-by-fee);
74-
/// may be unknown for unconfirmed transactions not in the mempool
74+
/// may be unknown for unconfirmed transactions not in the mempool.
7575
#[serde(rename = "bip125-replaceable")]
7676
pub bip125_replaceable: Bip125Replaceable,
7777
/// Only if 'category' is 'received'. List of parent descriptors for the output script of this

types/src/v29/blockchain/mod.rs

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ pub struct GetBlockVerboseOne {
3838
/// The block version formatted in hexadecimal.
3939
#[serde(rename = "versionHex")]
4040
pub version_hex: String,
41-
/// The merkle root
41+
/// The merkle root.
4242
#[serde(rename = "merkleroot")]
4343
pub merkle_root: String,
4444
/// The transaction ids.
@@ -118,7 +118,7 @@ pub struct GetBlockchainInfo {
118118
pub automatic_pruning: Option<bool>,
119119
/// The target size used by pruning (only present if automatic pruning is enabled).
120120
pub prune_target_size: Option<i64>,
121-
/// The block challenge (aka. block script)
121+
/// The block challenge (aka. block script).
122122
pub signet_challenge: Option<String>,
123123
/// Any network and blockchain warnings.
124124
pub warnings: Vec<String>,
@@ -165,7 +165,7 @@ pub struct GetBlockHeaderVerbose {
165165
pub nonce: i64,
166166
/// The bits.
167167
pub bits: String,
168-
/// The difficulty target (hex-encoded). From v29+
168+
/// The difficulty target (hex-encoded). From v29+.
169169
pub target: String,
170170
/// The difficulty.
171171
pub difficulty: f64,
@@ -238,19 +238,19 @@ pub struct SpendActivity {
238238
#[serde(deny_unknown_fields)]
239239
pub struct ReceiveActivity {
240240
// Note: 'type' field is used for deserialization tag, not included here explicitly.
241-
/// The total amount in BTC of the new output
241+
/// The total amount in BTC of the new output.
242242
pub amount: f64,
243-
/// The block that this receive is in
243+
/// The block that this receive is in.
244244
#[serde(default, skip_serializing_if = "Option::is_none")]
245245
#[serde(rename = "blockhash")]
246246
pub block_hash: Option<String>,
247-
/// The height of the receive
247+
/// The height of the receive.
248248
#[serde(default, skip_serializing_if = "Option::is_none")]
249249
pub height: Option<i64>,
250-
/// The txid of the receiving transaction
250+
/// The txid of the receiving transaction.
251251
pub txid: String,
252-
/// The vout of the receiving output
252+
/// The vout of the receiving output.
253253
pub vout: u32,
254-
/// The ScriptPubKey
254+
/// The ScriptPubKey.
255255
pub output_spk: ScriptPubkey,
256256
}

0 commit comments

Comments
 (0)