fix missing fullstops in bitcoin rustdoc
Added missing fullstops to the rustdoc titles for everything on the main page of the bitcoin crate
This commit is contained in:
parent
160f6de4b6
commit
4a9f74b55c
|
@ -1,6 +1,6 @@
|
|||
// SPDX-License-Identifier: CC0-1.0
|
||||
|
||||
//! BIP152 Compact Blocks
|
||||
//! BIP152 Compact Blocks.
|
||||
//!
|
||||
//! Implementation of compact blocks data structure and algorithms.
|
||||
|
||||
|
|
|
@ -57,9 +57,9 @@ const P: u8 = 19;
|
|||
const M: u64 = 784931;
|
||||
|
||||
hashes::hash_newtype! {
|
||||
/// Filter hash, as defined in BIP-157
|
||||
/// Filter hash, as defined in BIP-157.
|
||||
pub struct FilterHash(sha256d::Hash);
|
||||
/// Filter header, as defined in BIP-157
|
||||
/// Filter header, as defined in BIP-157.
|
||||
pub struct FilterHeader(sha256d::Hash);
|
||||
}
|
||||
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
// SPDX-License-Identifier: CC0-1.0
|
||||
|
||||
//! Witness
|
||||
//! A witness.
|
||||
//!
|
||||
//! This module contains the [`Witness`] struct and related methods to operate on it
|
||||
|
||||
|
|
|
@ -28,7 +28,7 @@ pub use secp256k1::{constants, Keypair, Parity, Secp256k1, Verification, XOnlyPu
|
|||
#[cfg(feature = "rand-std")]
|
||||
pub use secp256k1::rand;
|
||||
|
||||
/// A Bitcoin ECDSA public key
|
||||
/// A Bitcoin ECDSA public key.
|
||||
#[derive(Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
|
||||
pub struct PublicKey {
|
||||
/// Whether this public key should be serialized as compressed
|
||||
|
@ -269,7 +269,7 @@ impl From<&PublicKey> for PubkeyHash {
|
|||
fn from(key: &PublicKey) -> PubkeyHash { key.pubkey_hash() }
|
||||
}
|
||||
|
||||
/// An always-compressed Bitcoin ECDSA public key
|
||||
/// An always-compressed Bitcoin ECDSA public key.
|
||||
#[derive(Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
|
||||
pub struct CompressedPublicKey(pub secp256k1::PublicKey);
|
||||
|
||||
|
@ -393,7 +393,7 @@ impl From<&CompressedPublicKey> for WPubkeyHash {
|
|||
fn from(key: &CompressedPublicKey) -> Self { key.wpubkey_hash() }
|
||||
}
|
||||
|
||||
/// A Bitcoin ECDSA private key
|
||||
/// A Bitcoin ECDSA private key.
|
||||
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
|
||||
pub struct PrivateKey {
|
||||
/// Whether this private key should be serialized as compressed
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
// SPDX-License-Identifier: CC0-1.0
|
||||
|
||||
//! Signature
|
||||
//! A signature.
|
||||
//!
|
||||
//! This module provides signature related functions including secp256k1 signature recovery when
|
||||
//! library is used with the `secp-recovery` feature.
|
||||
|
|
|
@ -141,7 +141,7 @@ macro_rules! sha256t_hash_newtype_tag {
|
|||
($vis:vis, $tag:ident, $name:expr, $(#[$($attr:meta)*])*) => {
|
||||
#[doc = "The tag used for [`"]
|
||||
#[doc = $name]
|
||||
#[doc = "`]\n\n"]
|
||||
#[doc = "`].\n\n"]
|
||||
$(#[$($attr)*])*
|
||||
#[derive(Copy, Clone, PartialEq, Eq, Default, PartialOrd, Ord, Hash)]
|
||||
$vis struct $tag;
|
||||
|
|
|
@ -835,7 +835,7 @@ fn fmt_satoshi_in(
|
|||
Ok(())
|
||||
}
|
||||
|
||||
/// Amount
|
||||
/// An amount.
|
||||
///
|
||||
/// The [Amount] type can be used to express Bitcoin amounts that support
|
||||
/// arithmetic and conversion to various denominations.
|
||||
|
@ -1234,7 +1234,7 @@ enum DisplayStyle {
|
|||
DynamicDenomination,
|
||||
}
|
||||
|
||||
/// SignedAmount
|
||||
/// A signed amount.
|
||||
///
|
||||
/// The [SignedAmount] type can be used to express Bitcoin amounts that support
|
||||
/// arithmetic and conversion to various denominations.
|
||||
|
|
Loading…
Reference in New Issue