From 4a9f74b55c4f9a55b8e5eeb83e72a7d535078d82 Mon Sep 17 00:00:00 2001
From: "Jamil Lambert, PhD" <Jamil.Lambert@proton.me>
Date: Tue, 28 May 2024 12:08:44 +0100
Subject: [PATCH] fix missing fullstops in bitcoin rustdoc

Added missing fullstops to the rustdoc titles for everything on the main page of the bitcoin crate
---
 bitcoin/src/bip152.rs            | 2 +-
 bitcoin/src/bip158.rs            | 4 ++--
 bitcoin/src/blockdata/witness.rs | 2 +-
 bitcoin/src/crypto/key.rs        | 6 +++---
 bitcoin/src/sign_message.rs      | 2 +-
 hashes/src/sha256t.rs            | 2 +-
 units/src/amount.rs              | 4 ++--
 7 files changed, 11 insertions(+), 11 deletions(-)

diff --git a/bitcoin/src/bip152.rs b/bitcoin/src/bip152.rs
index ce5b7844b..ab809751b 100644
--- a/bitcoin/src/bip152.rs
+++ b/bitcoin/src/bip152.rs
@@ -1,6 +1,6 @@
 // SPDX-License-Identifier: CC0-1.0
 
-//! BIP152 Compact Blocks
+//! BIP152 Compact Blocks.
 //!
 //! Implementation of compact blocks data structure and algorithms.
 
diff --git a/bitcoin/src/bip158.rs b/bitcoin/src/bip158.rs
index 4d0bc4d38..7e54b810c 100644
--- a/bitcoin/src/bip158.rs
+++ b/bitcoin/src/bip158.rs
@@ -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);
 }
 
diff --git a/bitcoin/src/blockdata/witness.rs b/bitcoin/src/blockdata/witness.rs
index c118f5767..a1d9b40d6 100644
--- a/bitcoin/src/blockdata/witness.rs
+++ b/bitcoin/src/blockdata/witness.rs
@@ -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
 
diff --git a/bitcoin/src/crypto/key.rs b/bitcoin/src/crypto/key.rs
index 60bbe5c74..d1492b830 100644
--- a/bitcoin/src/crypto/key.rs
+++ b/bitcoin/src/crypto/key.rs
@@ -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
diff --git a/bitcoin/src/sign_message.rs b/bitcoin/src/sign_message.rs
index b373e4523..9f7bb524d 100644
--- a/bitcoin/src/sign_message.rs
+++ b/bitcoin/src/sign_message.rs
@@ -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.
diff --git a/hashes/src/sha256t.rs b/hashes/src/sha256t.rs
index 375154e97..0560bd3db 100644
--- a/hashes/src/sha256t.rs
+++ b/hashes/src/sha256t.rs
@@ -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;
diff --git a/units/src/amount.rs b/units/src/amount.rs
index 98e8216c8..40b3a6c7a 100644
--- a/units/src/amount.rs
+++ b/units/src/amount.rs
@@ -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.