From 314e8755df74cf0f07929553c49d1e86ddc93ba0 Mon Sep 17 00:00:00 2001 From: Martin Habovstiak Date: Fri, 7 Jan 2022 01:17:52 +0100 Subject: [PATCH] Clarify `global-context` feature Previously only `global-context-less-secure` was shown in the doc even though `global-context` may also work. This was strictly correct because `global-context` implies `global-context-less-secure` which is also documented but people could miss it or forget about it and then worry about security or worse, enable less secure feature. Calling out both fetures seems useful, even important and thankfully doesn't seem to cause too much noise in the docs. --- src/context.rs | 2 +- src/lib.rs | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/context.rs b/src/context.rs index 627e016..40ece1c 100644 --- a/src/context.rs +++ b/src/context.rs @@ -10,7 +10,7 @@ use Secp256k1; pub use self::alloc_only::*; #[cfg(feature = "global-context-less-secure")] -#[cfg_attr(docsrs, doc(cfg(feature = "global-context-less-secure")))] +#[cfg_attr(docsrs, doc(cfg(any(feature = "global-context", feature = "global-context-less-secure"))))] /// Module implementing a singleton pattern for a global `Secp256k1` context pub mod global { #[cfg(feature = "global-context")] diff --git a/src/lib.rs b/src/lib.rs index 4419006..96e5d26 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -188,7 +188,7 @@ use core::{mem, fmt, str}; use ffi::{CPtr, types::AlignedType}; #[cfg(feature = "global-context-less-secure")] -#[cfg_attr(docsrs, doc(cfg(feature = "global-context-less-secure")))] +#[cfg_attr(docsrs, doc(cfg(any(feature = "global-context", feature = "global-context-less-secure"))))] pub use context::global::SECP256K1; #[cfg(feature = "bitcoin_hashes")]