Merge rust-bitcoin/rust-bitcoin#4118: fix: typos in documentation files

83bd83385e Update sighash.rs (leopardracer)
fc4ea87429 Update transaction.rs (leopardracer)
0e70e85a1a Update key.rs (leopardracer)
f7c28ab44d Update input_string.rs (leopardracer)

Pull request description:

  This pull request contains changes to improve clarity, correctness and structure.
  - Corrected typos in multiple files (e.g., `transacton` → `transaction`, `function panics` formatting).
  - Improved readability of comments in `transaction.rs`, `key.rs`, and `input_string.rs.`
  - No functional code changes, only documentation updates.

  This message provides a clear summary of what was done and why the changes were made. Let me know if you need any modifications!

ACKs for top commit:
  Kixunil:
    ACK 83bd83385e
  tcharding:
    ACK 83bd83385e
  apoelstra:
    ACK 83bd83385e0bbad993f96f5abbe51f71d199aad1; successfully ran local tests

Tree-SHA512: ec0cae0357dd8c60e9286db71c3d18dfa6ba7acbaa27cce78c0586ab73c9631ea58ab453acd85b18d4edd72dcc578a4e08d69b9529e856837d5651efa288a4db

bitcoin/examples/sighash.rs

@@ -155,7 +155,7 @@ fn sighash_p2wpkh() {
 }
 
 fn sighash_p2sh_multisig_2x2() {
-    //Spending transactoin:
+    //Spending transaction:
     //bitcoin-cli getrawtransaction 214646c4b563cd8c788754ec94468ab71602f5ed07d5e976a2b0e41a413bcc0e  3
     //after decoding ScriptSig from the input:0, its last ASM element is the scriptpubkey:
     //bitcoin-cli decodescript 5221032d7306898e980c66aefdfb6b377eaf71597c449bf9ce741a3380c5646354f6de2103e8c742e1f283ef810c1cd0c8875e5c2998a05fc5b23c30160d3d33add7af565752ae

bitcoin/src/blockdata/transaction.rs

@@ -999,7 +999,7 @@ impl InputWeightPrediction {
     ///
     /// # Panics
     ///
-    /// The funcion panics in const context and debug builds if `bytes_to_grind` is higher than 62.
+    /// The function panics in const context and debug builds if `bytes_to_grind` is higher than 62.
     ///
     /// [signature grinding]: https://bitcoin.stackexchange.com/questions/111660/what-is-signature-grinding
     pub const fn ground_p2wpkh(bytes_to_grind: usize) -> Self {
@@ -1019,7 +1019,7 @@ impl InputWeightPrediction {
     ///
     /// # Panics
     ///
-    /// The funcion panics in const context and debug builds if `bytes_to_grind` is higher than 62.
+    /// The function panics in const context and debug builds if `bytes_to_grind` is higher than 62.
     ///
     /// [nested P2WPKH]: https://github.com/bitcoin/bips/blob/master/bip-0141.mediawiki#p2wpkh-nested-in-bip16-p2sh
     /// [signature grinding]: https://bitcoin.stackexchange.com/questions/111660/what-is-signature-grinding
@@ -1040,7 +1040,7 @@ impl InputWeightPrediction {
     ///
     /// # Panics
     ///
-    /// The funcion panics in const context and debug builds if `bytes_to_grind` is higher than 62.
+    /// The function panics in const context and debug builds if `bytes_to_grind` is higher than 62.
     ///
     /// [signature grinding]: https://bitcoin.stackexchange.com/questions/111660/what-is-signature-grinding
     pub const fn ground_p2pkh_compressed(bytes_to_grind: usize) -> Self {

bitcoin/src/crypto/key.rs

@@ -324,7 +324,7 @@ impl CompressedPublicKey {
 
     /// Serializes the public key.
     ///
-    /// As the type name suggests, the key is serialzied in compressed format.
+    /// As the type name suggests, the key is serialized in compressed format.
     ///
     /// Note that this can be used as a sort key to get BIP67-compliant sorting.
     /// That's why this type doesn't have the `to_sort_key` method - it would duplicate this one.

internals/src/error/input_string.rs

@@ -95,7 +95,7 @@ impl_from!(&str);
 ///
 /// This is created by `display_cannot_parse` method and should be used as
 /// `write_err!("{}", self.input.display_cannot_parse("what is parsed"); self.source)` in parse
-/// error [`Display`](fmt::Display) imlementation if the error has source. If the error doesn't
+/// error [`Display`](fmt::Display) implementation if the error has source. If the error doesn't
 /// have a source just use regular `write!` with same formatting arguments.
 pub struct CannotParse<'a, T: fmt::Display + ?Sized> {
     input: &'a InputString,