milksad
/
rust-bitcoin-unsafe-fast
14
0
Fork 0
Code Issues Pull Requests Activity

Fix clippy rustdocs warnings 

A new nightly version (`nightly-2024-08-28`) introduces a few warnings
because of our rustdocs. These are valid warnings and should be fixed,
thanks `clippy` team.

(The `bip152` change is a bit sloppy, open to suggestions.)
This commit is contained in:
Tobin C. Harding 2024-08-29 12:22:10 +10:00
parent cfb53c7866
commit b6371b5801
No known key found for this signature in database
GPG Key ID: 40BF9E4C269D6607
4 changed files with 14 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
bitcoin/src/bip152.rs
View File

@ -143,6 +143,8 @@ impl Decodable for ShortId {
} }
} }
/// A structure to relay a block header, short IDs, and a select few transactions.
///
/// A [`HeaderAndShortIds`] structure is used to relay a block header, the short /// A [`HeaderAndShortIds`] structure is used to relay a block header, the short
/// transactions IDs used for matching already-available transactions, and a /// transactions IDs used for matching already-available transactions, and a
/// select few transactions which we expect a peer may be missing. /// select few transactions which we expect a peer may be missing.

10
bitcoin/src/psbt/map/input.rs
View File

@ -131,10 +131,12 @@ pub struct Input {
pub unknown: BTreeMap<raw::Key, Vec<u8>>, pub unknown: BTreeMap<raw::Key, Vec<u8>>,
} }
/// A Signature hash type for the corresponding input. As of Taproot upgrade, the signature hash /// A Signature hash type for the corresponding input.
/// type can be either [`EcdsaSighashType`] or [`TapSighashType`] but it is not possible to know ///
/// directly which signature hash type the user is dealing with. Therefore, the user is responsible /// As of Taproot upgrade, the signature hash type can be either [`EcdsaSighashType`] or
/// for converting to/from [`PsbtSighashType`] from/to the desired signature hash type they need. /// [`TapSighashType`] but it is not possible to know directly which signature hash type the user is
/// dealing with. Therefore, the user is responsible for converting to/from [`PsbtSighashType`]
/// from/to the desired signature hash type they need.
/// ///
/// # Examples /// # Examples
/// ///

9
io/src/error.rs
View File

@ -116,10 +116,11 @@ impl From<Error> for std::io::Error {
macro_rules! define_errorkind { macro_rules! define_errorkind {
($($(#[$($attr:tt)*])* $kind:ident),*) => { ($($(#[$($attr:tt)*])* $kind:ident),*) => {
#[derive(Clone, Copy, Debug, Hash, PartialEq, Eq)] #[derive(Clone, Copy, Debug, Hash, PartialEq, Eq)]
/// A minimal subset of [`std::io::ErrorKind`] which is used for [`Error`]. Note that, as with /// A minimal subset of [`std::io::ErrorKind`] which is used for [`Error`].
/// [`std::io`], only [`Self::Interrupted`] has defined semantics in this crate, all other ///
/// variants are provided here only to provide higher-fidelity conversions to and from /// Note that, as with [`std::io`], only [`Self::Interrupted`] has defined semantics in this
/// [`std::io::Error`]. /// crate, all other variants are provided here only to provide higher-fidelity conversions
/// to and from [`std::io::Error`].
pub enum ErrorKind { pub enum ErrorKind {
$( $(
$(#[$($attr)*])* $(#[$($attr)*])*

1
units/src/amount.rs
View File

@ -1638,6 +1638,7 @@ pub mod serde {
#![allow(missing_docs)] #![allow(missing_docs)]
//! This module adds serde serialization and deserialization support for Amounts. //! This module adds serde serialization and deserialization support for Amounts.
//!
//! Since there is not a default way to serialize and deserialize Amounts, multiple //! Since there is not a default way to serialize and deserialize Amounts, multiple
//! ways are supported and it's up to the user to decide which serialiation to use. //! ways are supported and it's up to the user to decide which serialiation to use.
//! The provided modules can be used as follows: //! The provided modules can be used as follows: