Skip to content

Commit d068fd7

Browse files
committed
Merge #365: Fixed docs(rs)
314e875 Clarify `global-context` feature (Martin Habovstiak) d52ab85 Added missing features to docs.rs config (Martin Habovstiak) Pull request description: Sadly, I missed two details in #353: features missing in docs.rs configuration and `global-context` being a bit confusing. This PR fixes those, see commit messages for details. ACKs for top commit: apoelstra: ACK 314e875 Tree-SHA512: 01bed8ae2f30adcbdd436b514f08a084492d7f4e1a739ca62e6d8b8547e379c01faeda3522733c27ab615acbb4c6cff60e13906cc88a0d2b90e439e7da517466
2 parents fe76cad + 314e875 commit d068fd7

File tree

3 files changed

+3
-3
lines changed

3 files changed

+3
-3
lines changed

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ autoexamples = false # Remove when edition 2018 https://github.com/rust-lang/car
1414

1515
# Should make docs.rs show all functions, even those behind non-default features
1616
[package.metadata.docs.rs]
17-
features = [ "rand", "rand-std", "serde", "recovery" ]
17+
features = [ "rand", "rand-std", "serde", "bitcoin_hashes", "recovery", "global-context" ]
1818
rustdoc-args = ["--cfg", "docsrs"]
1919

2020
[features]

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
@@ -190,7 +190,7 @@ use core::{mem, fmt, str};
190190
use ffi::{CPtr, types::AlignedType};
191191

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

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

0 commit comments

Comments
 (0)