Minor documentation fixups

src/crypto.rs

@@ -15,6 +15,10 @@ pub struct PublicKey {
 
 impl PublicKey {
     /// Verify that `sig` is a valid signature on `data` from this key.
+    ///
+    /// # Panics
+    ///
+    /// Panics if the public key bytes are not a valid Ed25519 public key.
     pub fn verify_signature(&self, data: impl AsRef<[u8]>, sig: &Signature) -> bool {
         let verifier = ed25519_dalek::VerifyingKey::from_bytes(&self.bytes).unwrap();
         let signature = ed25519_dalek::Signature::from(&sig.bytes);

src/log.rs

@@ -2,8 +2,8 @@
 
 use crate::crypto::{Hash, PublicKey, Signature};
 
-#[derive(Debug, Clone, PartialEq)]
 /// A signed tree head, as returned by the get-tree-head endpoint.
+#[derive(Debug, Clone, PartialEq)]
 pub struct SignedTreeHead {
     pub size: u64,
     pub root_hash: Hash,
@@ -19,23 +19,23 @@ pub struct WitnessCosignature {
     pub cosignature: Signature,
 }
 
-#[derive(Debug, Clone, PartialEq)]
 /// An inclusion proof, as returned by the get-inclusion-proof endpoint.
+#[derive(Debug, Clone, PartialEq)]
 pub struct InclusionProof {
     pub leaf_index: u64,
     pub node_hashes: Vec<Hash>,
 }
 
-#[derive(Debug, Clone, PartialEq)]
 /// A protoleaf, which is the data submitted to the add-leaf endpoint of a Sigsum log.
+#[derive(Debug, Clone, PartialEq)]
 pub struct Protoleaf {
     pub message: Hash,
     pub signature: Signature,
     pub public_key: PublicKey,
 }
 
-#[derive(Debug, Clone, PartialEq)]
 /// A tree leaf, as stored in a sigsum log.
+#[derive(Debug, Clone, PartialEq)]
 pub struct Leaf {
     pub digest: Hash,
     pub signature: Signature,

src/policy/mod.rs

@@ -159,7 +159,7 @@ pub enum PolicyError {
     #[error("duplicate name")]
     DuplicateName(String),
 
-    #[error("{0}: no sutch witness")]
+    #[error("{0}: no such witness")]
     UnknownName(String),
 
     #[error("quorum already set")]

src/policy/parsing.rs

@@ -350,7 +350,7 @@ mod tests {
         );
         insta::assert_snapshot!(
             parse_policy("quorum foo").unwrap_err(),
-            @"line 1: invalid quorum rule: foo: no sutch witness",
+            @"line 1: invalid quorum rule: foo: no such witness",
         );
     }