Skip to content

Commit 3892580

Browse files
authored
k256: add Ethereum note to ecdsa module rustdoc (#270)
Per #269 it seems this might've been a bit hard to discover, so this note hopefully makes it easier.
1 parent df20360 commit 3892580

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

k256/src/ecdsa.rs

+6
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,12 @@
2828
//! Most users of this library who want to sign/verify signatures will want to
2929
//! enable the `ecdsa` and `sha256` Cargo features.
3030
//!
31+
//! ## Ethereum Support
32+
//!
33+
//! This crate natively supports Ethereum-style recoverable signatures.
34+
//! Please see the toplevel documentation of the [`recoverable`] module
35+
//! for more information.
36+
//!
3137
//! ## Signing/Verification Example
3238
//!
3339
//! This example requires the `ecdsa` and `sha256` Cargo features are enabled:

0 commit comments

Comments
 (0)