Skip to content

Commit

Permalink
kernel: hil: pkc: sig: update comment
Browse files Browse the repository at this point in the history
  • Loading branch information
bradjc committed Feb 23, 2024
1 parent 6ae49e3 commit 8c7d983
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions kernel/src/hil/public_key_crypto/signature.rs
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@ use crate::ErrorCode;
pub trait ClientVerify<const HL: usize, const SL: usize> {
/// Called when the verification is complete.
///
/// If the verification operation did not encounter any errors, `result`
/// will be set to `Ok()`. If the signature was correctly verified `result`
/// will be `Ok(true)`. If the signature did not match the hash `result`
/// will be `Ok(false)`.
/// If the verification operation encounters an error, result will be a
/// `Result::Err()` specifying the ErrorCode. Otherwise, result will be a
/// `Result::Ok` set to `Ok(true)` if the signature was correctly verified
/// and `Ok(false)` otherwise.
///
/// If verification operation did encounter errors `result` will be `Err()`
/// with an appropriate `ErrorCode`. Valid `ErrorCode`s include:
Expand Down

0 comments on commit 8c7d983

Please sign in to comment.