Improve documentation on docs.rs (#17)

This commit is contained in:
daxpedda
2021-09-30 14:00:32 -07:00
committed by GitHub
parent 7be67b26de
commit ad04f224af
5 changed files with 10 additions and 0 deletions
+5
View File
@@ -55,3 +55,8 @@ proptest = "1"
regex = "1"
rustyline = "8"
voprf = { path = "", default-features = false, features = ["std"] }
[package.metadata.docs.rs]
features = ["p256", "std"]
targets = []
rustdoc-args = ["--cfg", "docsrs"]
+1
View File
@@ -57,4 +57,5 @@ impl Debug for InternalError {
}
#[cfg(feature = "std")]
#[cfg_attr(docsrs, doc(cfg(feature = "std")))]
impl Error for InternalError {}
+1
View File
@@ -9,6 +9,7 @@
mod expand;
#[cfg(feature = "p256")]
#[cfg_attr(docsrs, doc(cfg(feature = "p256")))]
pub(crate) mod p256;
mod ristretto;
+2
View File
@@ -129,6 +129,7 @@ macro_rules! impl_zeroize_on_drop_for {
macro_rules! impl_serialize_and_deserialize_for {
($t:ident) => {
#[cfg(feature = "serialize")]
#[cfg_attr(docsrs, doc(cfg(feature = "serialize")))]
impl<CS: CipherSuite> serde::Serialize for $t<CS> {
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where
@@ -143,6 +144,7 @@ macro_rules! impl_serialize_and_deserialize_for {
}
#[cfg(feature = "serialize")]
#[cfg_attr(docsrs, doc(cfg(feature = "serialize")))]
impl<'de, CS: CipherSuite> serde::Deserialize<'de> for $t<CS> {
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where
+1
View File
@@ -476,6 +476,7 @@
#![cfg_attr(not(feature = "bench"), deny(missing_docs))]
#![deny(unsafe_code)]
#![cfg_attr(not(feature = "std"), no_std)]
#![cfg_attr(docsrs, feature(doc_cfg))]
extern crate alloc;