From db50509cd3a93bfc59995563c187c20835c5f0f6 Mon Sep 17 00:00:00 2001
From: "Tobin C. Harding" <me@tobin.cc>
Date: Fri, 21 Jul 2023 10:44:16 +1000
Subject: [PATCH] Add usage docs to the "core2" feature

We do not expect users of `rust-bitcoin` to ever activate the "core2"
dependency directly, add a comment explaining that.
---
 bitcoin/Cargo.toml | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/bitcoin/Cargo.toml b/bitcoin/Cargo.toml
index 0b5f47fe..ceb793c9 100644
--- a/bitcoin/Cargo.toml
+++ b/bitcoin/Cargo.toml
@@ -42,6 +42,8 @@ hex_lit = "0.1.1"
 
 base64 = { version = "0.13.0", optional = true }
 bitcoinconsensus = { version = "0.20.2-0.5.0", default-features = false, optional = true }
+
+# There is no reason to use this dependency directly, it is activated by the "no-std" feature.
 core2 = { version = "0.3.2", default-features = false, features = ["alloc"], optional = true }
 # Do NOT use this as a feature! Use the `serde` feature instead.
 actual-serde = { package = "serde", version = "1.0.103", default-features = false, features = [ "derive", "alloc" ], optional = true }