|
122 | 122 | //!
|
123 | 123 | //! Despite being post-1.0, this crate includes a number of off-by-default
|
124 | 124 | //! unstable features named `*-preview`, each of which depends on a pre-1.0
|
125 |
| -//! crate. These features are as follows: |
| 125 | +//! crate. |
| 126 | +//! |
| 127 | +//! These features are considered exempt from SemVer. See the |
| 128 | +//! [SemVer policy](#semver-policy) above for more information. |
| 129 | +//! |
| 130 | +//! The following unstable features are presently supported: |
126 | 131 | //!
|
127 | 132 | //! - `derive-preview`: for implementers of signature systems using
|
128 | 133 | //! [`DigestSigner`] and [`DigestVerifier`], the `derive-preview` feature
|
|
134 | 139 | //! digest signer/verifier type. Enabling this feature also enables `digest`
|
135 | 140 | //! support (see immediately below).
|
136 | 141 | //! - `digest-preview`: enables the [`DigestSigner`] and [`DigestVerifier`]
|
137 |
| -//! traits which are based on the `Digest` trait from the `digest` crate. |
| 142 | +//! traits which are based on the [`Digest`] trait from the [`digest`] crate. |
138 | 143 | //! These traits are used for representing signature systems based on the
|
139 | 144 | //! [Fiat-Shamir heuristic] which compute a random challenge value to sign
|
140 | 145 | //! by computing a cryptographically secure digest of the input message.
|
141 | 146 | //! - `rand-preview`: enables the [`RandomizedSigner`] trait for signature
|
142 | 147 | //! systems which rely on a cryptographically secure random number generator
|
143 | 148 | //! for security.
|
144 | 149 | //!
|
| 150 | +//! [`Digest`]: https://docs.rs/digest/latest/digest/trait.Digest.html |
| 151 | +//! [`digest`]: https://docs.rs/digest/latest/digest/ |
145 | 152 | //! [Fiat-Shamir heuristic]: https://en.wikipedia.org/wiki/Fiat%E2%80%93Shamir_heuristic
|
146 | 153 |
|
147 | 154 | #![no_std]
|
| 155 | +#![cfg_attr(docsrs, feature(doc_cfg))] |
148 | 156 | #![doc(
|
149 | 157 | html_logo_url = "https://raw.githubusercontent.com/RustCrypto/meta/master/logo_small.png",
|
150 |
| - html_root_url = "https://docs.rs/signature/1.0.0-pre.3" |
| 158 | + html_root_url = "https://docs.rs/signature/1.0.0-pre.5" |
151 | 159 | )]
|
152 |
| -#![cfg_attr(docsrs, feature(doc_cfg))] |
153 | 160 | #![forbid(unsafe_code)]
|
154 | 161 | #![warn(
|
155 | 162 | missing_docs,
|
|
0 commit comments