Skip to content

Commit e9f5e0c

Browse files
committed
Do a bunch of trivial rustdocs fixes
Shoosh the linter by doing a bunch of trivial fixes to rustdocs.
1 parent ee403b6 commit e9f5e0c

File tree

8 files changed

+15
-18
lines changed

8 files changed

+15
-18
lines changed

bitcoin/src/address.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -699,8 +699,8 @@ impl NetworkValidation for NetworkUnchecked {
699699
/// ```
700700
///
701701
/// 2. `Debug` on `Address<NetworkUnchecked>` does not produce clean address but address wrapped by
702-
/// an indicator that its network has not been checked. This is to encourage programmer to properly
703-
/// check the network and use `Display` in user-facing context.
702+
/// an indicator that its network has not been checked. This is to encourage programmer to
703+
/// properly check the network and use `Display` in user-facing context.
704704
///
705705
/// ```
706706
/// # use std::str::FromStr;

bitcoin/src/blockdata/transaction.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -770,8 +770,8 @@ impl Transaction {
770770
/// # Warning
771771
///
772772
/// - Does NOT attempt to support OP_CODESEPARATOR. In general this would require evaluating
773-
/// `script_pubkey` to determine which separators get evaluated and which don't, which we don't
774-
/// have the information to determine.
773+
/// `script_pubkey` to determine which separators get evaluated and which don't, which we
774+
/// don't have the information to determine.
775775
/// - Does NOT handle the sighash single bug (see "Returns" section)
776776
///
777777
/// # Returns

bitcoin/src/crypto/key.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -663,6 +663,7 @@ impl TapTweak for UntweakedKeyPair {
663663
/// * p is the internal private key
664664
/// * H is the hash function
665665
/// * c is the commitment data
666+
///
666667
/// The public key is generated from a private key by multiplying with generator point, Q = qG.
667668
///
668669
/// # Returns

bitcoin/src/crypto/sighash.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -846,8 +846,8 @@ impl<R: Borrow<Transaction>> SighashCache<R> {
846846
/// # Warning
847847
///
848848
/// - Does NOT attempt to support OP_CODESEPARATOR. In general this would require evaluating
849-
/// `script_pubkey` to determine which separators get evaluated and which don't, which we don't
850-
/// have the information to determine.
849+
/// `script_pubkey` to determine which separators get evaluated and which don't, which we
850+
/// don't have the information to determine.
851851
/// - Does NOT handle the sighash single bug (see "Return type" section)
852852
///
853853
/// # Returns

bitcoin/src/lib.rs

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -20,16 +20,13 @@
2020
//! * `secp-recovery` - enables calculating public key from a signature and message.
2121
//! * `base64` - (dependency), enables encoding of PSBTs and message signatures.
2222
//! * `rand` - (dependency), makes it more convenient to generate random values.
23-
//! * `serde` - (dependency), implements `serde`-based serialization and
24-
//! deserialization.
23+
//! * `serde` - (dependency), implements `serde`-based serialization and deserialization.
2524
//! * `secp-lowmemory` - optimizations for low-memory devices.
26-
//! * `no-std` - enables additional features required for this crate to be usable
27-
//! without std. Does **not** disable `std`. Depends on `core2`.
28-
//! * `bitcoinconsensus-std` - enables `std` in `bitcoinconsensus` and communicates it
29-
//! to this crate so it knows how to implement
30-
//! `std::error::Error`. At this time there's a hack to
31-
//! achieve the same without this feature but it could
32-
//! happen the implementations diverge one day.
25+
//! * `no-std` - enables additional features required for this crate to be usable without std. Does
26+
//! **not** disable `std`. Depends on `core2`.
27+
//! * `bitcoinconsensus-std` - enables `std` in `bitcoinconsensus` and communicates it to this crate
28+
//! so it knows how to implement `std::error::Error`. At this time there's a hack to achieve the
29+
//! same without this feature but it could happen the implementations diverge one day.
3330
3431
#![cfg_attr(all(not(feature = "std"), not(test)), no_std)]
3532
// Experimental features we need.

bitcoin/src/merkle_tree/block.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -192,6 +192,7 @@ impl Decodable for MerkleBlock {
192192
/// - uint256[] hashes in depth-first order (<= 32*N bytes)
193193
/// - varint number of bytes of flag bits (1-3 bytes)
194194
/// - byte[] flag bits, packed per 8 in a byte, least significant bit first (<= 2*N-1 bits)
195+
///
195196
/// The size constraints follow from this.
196197
#[derive(PartialEq, Eq, Clone, Debug)]
197198
pub struct PartialMerkleTree {

bitcoin/src/network/message_network.rs

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,6 @@ use crate::network::address::Address;
1515
use crate::network::constants::{self, ServiceFlags};
1616
use crate::prelude::*;
1717

18-
/// Some simple messages
19-
2018
/// The `version` message
2119
#[derive(PartialEq, Eq, Clone, Debug)]
2220
pub struct VersionMessage {

hashes/src/internal_macros.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ pub(crate) use arr_newtype_fmt_impl;
5454
///
5555
/// * `$bits` - number of bits this hash type has
5656
/// * `$reverse` - `bool` - `true` if the hash type should be displayed backwards, `false`
57-
/// otherwise.
57+
/// otherwise.
5858
/// * `$gen: $gent` - generic type(s) and trait bound(s)
5959
///
6060
/// Restrictions on usage:

0 commit comments

Comments
 (0)