From 8b9663b250eabb024fc121daac63ddd104ccfc64 Mon Sep 17 00:00:00 2001 From: "Jamil Lambert, PhD" Date: Mon, 17 Nov 2025 15:22:02 +0000 Subject: [PATCH 1/2] Remove doc_auto_cfg from node and jsonrpc crates This attribute prevent the rustdocs from being generated. Remove it from these two published crates so that the docs will be built next release. --- jsonrpc/src/lib.rs | 1 - node/src/lib.rs | 1 - 2 files changed, 2 deletions(-) diff --git a/jsonrpc/src/lib.rs b/jsonrpc/src/lib.rs index 473eba27..ee2953ee 100644 --- a/jsonrpc/src/lib.rs +++ b/jsonrpc/src/lib.rs @@ -4,7 +4,6 @@ //! //! Rust support for the JSON-RPC 2.0 protocol. -#![cfg_attr(docsrs, feature(doc_auto_cfg))] // Coding conventions #![warn(missing_docs)] diff --git a/node/src/lib.rs b/node/src/lib.rs index 6d733b45..d36b3415 100644 --- a/node/src/lib.rs +++ b/node/src/lib.rs @@ -1,4 +1,3 @@ -#![cfg_attr(docsrs, feature(doc_auto_cfg))] #![cfg_attr(docsrs, cfg_attr(all(), doc = include_str!("../README.md")))] pub extern crate corepc_client as client; From 4defca40df2ca74374b935b322d0141fe31eee8d Mon Sep 17 00:00:00 2001 From: "Jamil Lambert, PhD" Date: Mon, 17 Nov 2025 15:22:22 +0000 Subject: [PATCH 2/2] Add node crate crate level docs Add a brief description of the node crate at the crate level. The readme follows with the details. --- node/src/lib.rs | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/node/src/lib.rs b/node/src/lib.rs index d36b3415..d678c2a5 100644 --- a/node/src/lib.rs +++ b/node/src/lib.rs @@ -1,3 +1,9 @@ +// SPDX-License-Identifier: CC0-1.0 + +//! # Rust Bitcoin Core node harness +//! +//! Utilities used to spin up, configure and drive `bitcoind` instances. + #![cfg_attr(docsrs, cfg_attr(all(), doc = include_str!("../README.md")))] pub extern crate corepc_client as client;