From 81d21ecab7fbe05c5bff3dee66aa737562d8f6e1 Mon Sep 17 00:00:00 2001
From: Justus Winter <justus@sequoia-pgp.org>
Date: Tue, 29 Sep 2020 12:10:54 +0200
Subject: openpgp: Add comment.

---
 openpgp/src/cert/mod.rs | 5 +++++
 1 file changed, 5 insertions(+)

(limited to 'openpgp')

diff --git a/openpgp/src/cert/mod.rs b/openpgp/src/cert/mod.rs
index 81f8740b..cf1d2739 100644
--- a/openpgp/src/cert/mod.rs
+++ b/openpgp/src/cert/mod.rs
@@ -227,6 +227,11 @@ fn canonical_signature_order(a: Option<time::SystemTime>, b: Option<time::System
     a.cmp(&b).reverse()
 }
 
+/// Compares two signatures by creation time using the MPIs as tie
+/// breaker.
+///
+/// Useful to sort signatures so that the most recent ones are at the
+/// front.
 fn sig_cmp(a: &Signature, b: &Signature) -> Ordering {
     match canonical_signature_order(a.signature_creation_time(),
                                     b.signature_creation_time()) {
-- 
cgit v1.2.3