fixup! fixup! fixup! fixup! fixup! chore: apply suggestions from code…

… review (#13) Co-authored-by: Falko Galperin <[email protected]>
namib-project · Aug 4, 2024 · 23159b4 · 23159b4
1 parent 65243c2
commit 23159b4
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 5 deletions.
diff --git a/src/lib.rs b/src/lib.rs
@@ -161,8 +161,8 @@
 //! # Token handling
 //!
 //! This crate also provides some functionality regarding the encoding and decoding of access
-//! tokens, especially of CBOR Web Tokens (CWTs), which are based on the COSE specification
-//! (RFC 9052).
+//! tokens, especially of CBOR Web Tokens (CWTs, [RFC 8392](https://datatracker.ietf.org/doc/html/rfc8392)), 
+//! which are based on the COSE specification ([RFC 9052](https://datatracker.ietf.org/doc/html/rfc9052)).
 //!
 //! Generation and validation of CWTs is supported for CWTs based on signed and encrypted
 //! COSE objects. Additionally, helper methods are provided to more easily create and validate

diff --git a/src/token/cose/recipient/mod.rs b/src/token/cose/recipient/mod.rs
@@ -370,7 +370,7 @@ impl<'a, B: KeyDistributionCryptoBackend, CKP: KeyProvider, AAD: AadProvider>
     }
 }
 
-/// Determine the key operations that a key might have in order to be valid for an encryption
+/// Determine the key operations that a key may have in order to be valid for an encryption
 /// operation of the given `algorithm`.
 fn determine_encrypt_key_ops_for_alg<CE: Display>(
     algorithm: iana::Algorithm,
@@ -425,7 +425,7 @@ fn determine_encrypt_key_ops_for_alg<CE: Display>(
     }))
 }
 
-/// Determine the key operations that a key might have in order to be valid for a decryption
+/// Determine the key operations that a key may have in order to be valid for a decryption
 /// operation of the given `algorithm`.
 fn determine_decrypt_key_ops_for_alg<CE: Display>(
     alg: iana::Algorithm,

diff --git a/src/token/cose/test_helper.rs b/src/token/cose/test_helper.rs
@@ -417,7 +417,7 @@ pub trait CoseStructTestHelper<B: CryptoBackend>:
     fn check_against_test_case(&self, case: &TestCase, backend: &mut B);
 }
 
-/// Apply failures to `hdr` based on a description given in `failures`
+/// Apply failures to `hdr` based on a description given in `failures`.
 pub(crate) fn apply_header_failures(hdr: &mut Header, failures: &TestCaseFailures) {
     if let Some(headers_to_remove) = &failures.remove_protected_headers {
         if !headers_to_remove.key_id.is_empty() {