Skip to content

Commit 314e875

Browse files
committed
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.
1 parent d52ab85 commit 314e875

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

src/context.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ use Secp256k1;
1010
pub use self::alloc_only::*;
1111

1212
#[cfg(feature = "global-context-less-secure")]
13-
#[cfg_attr(docsrs, doc(cfg(feature = "global-context-less-secure")))]
13+
#[cfg_attr(docsrs, doc(cfg(any(feature = "global-context", feature = "global-context-less-secure"))))]
1414
/// Module implementing a singleton pattern for a global `Secp256k1` context
1515
pub mod global {
1616
#[cfg(feature = "global-context")]

src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -188,7 +188,7 @@ use core::{mem, fmt, str};
188188
use ffi::{CPtr, types::AlignedType};
189189

190190
#[cfg(feature = "global-context-less-secure")]
191-
#[cfg_attr(docsrs, doc(cfg(feature = "global-context-less-secure")))]
191+
#[cfg_attr(docsrs, doc(cfg(any(feature = "global-context", feature = "global-context-less-secure"))))]
192192
pub use context::global::SECP256K1;
193193

194194
#[cfg(feature = "bitcoin_hashes")]

0 commit comments

Comments
 (0)