summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorNeal H. Walfield <neal@sequoia-pgp.org>2024-01-24 15:59:13 +0100
committerNeal H. Walfield <neal@sequoia-pgp.org>2024-01-24 16:01:48 +0100
commit5d2f1f8eb72c484144de702dcd5344115ce91b3d (patch)
treea3c298c4ef0e7eabed95f882160956de5d1210ff
parenteaf8bff6aa524ba46e11e3d2ad272c1d8a568d61 (diff)
openpgp: Improve documentation.
- Add references to related functions.
-rw-r--r--openpgp/src/packet/signature.rs5
1 files changed, 5 insertions, 0 deletions
diff --git a/openpgp/src/packet/signature.rs b/openpgp/src/packet/signature.rs
index b9e91268..41f56453 100644
--- a/openpgp/src/packet/signature.rs
+++ b/openpgp/src/packet/signature.rs
@@ -2226,6 +2226,11 @@ impl crate::packet::Signature {
/// and the Issuer Fingerprint subpacket in both the hashed
/// subpacket area and the unhashed subpacket area.
///
+ /// If you are only looking for the issuer subpackets use
+ /// [`SubpacketAreas::issuers`], or if you are looking only for
+ /// the issuer fingerprint subpackets use
+ /// [`SubpacketAreas::issuer_fingerprints`].
+ ///
/// The issuers are sorted so that the `Fingerprints` come before
/// `KeyID`s. The `Fingerprint`s and `KeyID`s are not further
/// sorted, but are returned in the order that they are