Merge rust-bitcoin/rust-bitcoin#1841: docs: Add doc comments for external crates

639c548aed docs: Add doc comments for external crates (yancy)

Pull request description:

  A new version of rust nightly is causing a test failure for external crates that are not documented.  This is currently causing a failure on my branch here: https://github.com/rust-bitcoin/rust-bitcoin/pull/1838

  As a side note, it feels like this should be locked to a specific version of nightly in the CI tests and then updated as a choir instead of having it create a new problem in a branch that's not related.

ACKs for top commit:
  apoelstra:
    ACK 639c548aed
  tcharding:
    ACK 639c548aed

Tree-SHA512: 764999edc448bff88013301bef287b16ac750af560931470257f2b4475747d52546e73d7fd9a7bdf2cedb18178f370150351e40f176f3da929edf686f02f5c1a
This commit is contained in:
sanket1729 2023-05-08 18:34:17 -07:00
commit 7c6a7c34b8
No known key found for this signature in database
GPG Key ID: 648FFB183E0870A2
2 changed files with 13 additions and 0 deletions

View File

@ -56,11 +56,21 @@ extern crate test;
extern crate alloc; extern crate alloc;
#[cfg(feature = "base64")] #[cfg(feature = "base64")]
/// Encodes and decodes base64 as bytes or utf8.
pub extern crate base64; pub extern crate base64;
/// Encodes and decodes the Bech32 forrmat.
pub extern crate bech32; pub extern crate bech32;
#[cfg(feature = "bitcoinconsensus")] #[cfg(feature = "bitcoinconsensus")]
/// Bitcoin's libbitcoinconsensus with Rust binding.
pub extern crate bitcoinconsensus; pub extern crate bitcoinconsensus;
/// Rust implementation of cryptographic hash function algorithems.
pub extern crate hashes; pub extern crate hashes;
/// Rust wrapper library for Pieter Wuille's libsecp256k1. Implements ECDSA and BIP 340 signatures
/// for the SECG elliptic curve group secp256k1 and related utilities.
pub extern crate secp256k1; pub extern crate secp256k1;
#[cfg(feature = "serde")] #[cfg(feature = "serde")]

View File

@ -85,8 +85,11 @@ extern crate alloc;
extern crate core; extern crate core;
#[cfg(feature = "core2")] #[cfg(feature = "core2")]
extern crate core2; extern crate core2;
#[cfg(feature = "serde")] #[cfg(feature = "serde")]
/// A generic serialization/deserialization framework.
pub extern crate serde; pub extern crate serde;
#[cfg(all(test, feature = "serde"))] #[cfg(all(test, feature = "serde"))]
extern crate serde_test; extern crate serde_test;
#[cfg(bench)] #[cfg(bench)]