From 1e201562dfc80ff1e8e2ad639ab5298c5b43211e Mon Sep 17 00:00:00 2001 From: Luke Parker Date: Tue, 7 Mar 2023 05:34:29 -0500 Subject: [PATCH] Correct doc comments re: HTML tags --- crypto/dleq/src/lib.rs | 4 ++-- crypto/frost/src/algorithm.rs | 2 +- crypto/schnorr/src/aggregate.rs | 2 +- crypto/schnorr/src/lib.rs | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/crypto/dleq/src/lib.rs b/crypto/dleq/src/lib.rs index 71b9cb4b..25062feb 100644 --- a/crypto/dleq/src/lib.rs +++ b/crypto/dleq/src/lib.rs @@ -191,7 +191,7 @@ impl DLEqProof { Ok(DLEqProof { c: read_scalar(r)?, s: read_scalar(r)? }) } - /// Serialize a DLEq proof to a Vec. + /// Serialize a DLEq proof to a `Vec`. #[cfg(feature = "serialize")] pub fn serialize(&self) -> Vec { let mut res = vec![]; @@ -315,7 +315,7 @@ impl MultiDLEqProof { Ok(MultiDLEqProof { c, s }) } - /// Serialize a multi-DLEq proof to a Vec. + /// Serialize a multi-DLEq proof to a `Vec`. #[cfg(feature = "serialize")] pub fn serialize(&self) -> Vec { let mut res = vec![]; diff --git a/crypto/frost/src/algorithm.rs b/crypto/frost/src/algorithm.rs index a8222168..6c5cac9a 100644 --- a/crypto/frost/src/algorithm.rs +++ b/crypto/frost/src/algorithm.rs @@ -155,7 +155,7 @@ impl> Schnorr { impl> IetfSchnorr { /// Construct a IETF-compatible Schnorr algorithm. /// - /// Please see the IetfSchnorr documentation for the full details of this. + /// Please see the `IetfSchnorr` documentation for the full details of this. pub fn ietf() -> IetfSchnorr { Schnorr::new(IetfTranscript(vec![])) } diff --git a/crypto/schnorr/src/aggregate.rs b/crypto/schnorr/src/aggregate.rs index 52a9554f..592ed051 100644 --- a/crypto/schnorr/src/aggregate.rs +++ b/crypto/schnorr/src/aggregate.rs @@ -99,7 +99,7 @@ impl SchnorrAggregate { writer.write_all(self.s.to_repr().as_ref()) } - /// Serialize a SchnorrAggregate, returning a Vec. + /// Serialize a SchnorrAggregate, returning a `Vec`. pub fn serialize(&self) -> Vec { let mut buf = vec![]; self.write(&mut buf).unwrap(); diff --git a/crypto/schnorr/src/lib.rs b/crypto/schnorr/src/lib.rs index f53fb26c..f852eee2 100644 --- a/crypto/schnorr/src/lib.rs +++ b/crypto/schnorr/src/lib.rs @@ -46,7 +46,7 @@ impl SchnorrSignature { writer.write_all(self.s.to_repr().as_ref()) } - /// Serialize a SchnorrSignature, returning a Vec. + /// Serialize a SchnorrSignature, returning a `Vec`. pub fn serialize(&self) -> Vec { let mut buf = vec![]; self.write(&mut buf).unwrap();