summaryrefslogtreecommitdiffstats
path: root/openpgp/src
diff options
context:
space:
mode:
authorWiktor Kwapisiewicz <wiktor@metacode.biz>2020-10-27 22:00:15 +0100
committerWiktor Kwapisiewicz <wiktor@metacode.biz>2020-10-27 22:00:15 +0100
commit87f1c774db761b999b505b73d4a922a41756335e (patch)
treec867b1f2eaf8e7605e81ea34063371fc4fc5d7ab /openpgp/src
parent85353786abf2fa87746ae5a6a25e60cf88411f66 (diff)
openpgp: Fix wording on functions returning iterators.
- Functions that had their return values changed from a single item to impl Iterators had obsolete documentation. Fix this. - Closes #593.
Diffstat (limited to 'openpgp/src')
-rw-r--r--openpgp/src/packet/signature/subpacket.rs15
1 files changed, 7 insertions, 8 deletions
diff --git a/openpgp/src/packet/signature/subpacket.rs b/openpgp/src/packet/signature/subpacket.rs
index 42430a4f..7c258010 100644
--- a/openpgp/src/packet/signature/subpacket.rs
+++ b/openpgp/src/packet/signature/subpacket.rs
@@ -2716,7 +2716,7 @@ impl SubpacketAreas {
}
}
- /// Returns the value of any Regular Expression subpackets.
+ /// Returns the values of all Regular Expression subpackets.
///
/// The [Regular Expression subpacket] is used in conjunction with
/// a [Trust Signature subpacket], which is accessed using
@@ -2777,7 +2777,7 @@ impl SubpacketAreas {
}
}
- /// Returns the value of the Revocation Key subpacket.
+ /// Returns the values of all Revocation Key subpackets.
///
/// A [Revocation Key subpacket] indicates certificates (so-called
/// designated revokers) that are allowed to revoke the signer's
@@ -2812,7 +2812,7 @@ impl SubpacketAreas {
})
}
- /// Returns the value of any Issuer subpackets.
+ /// Returns the values of all Issuer subpackets.
///
/// The [Issuer subpacket] is used when processing a signature to
/// identify which certificate created the signature. Since this
@@ -2835,7 +2835,7 @@ impl SubpacketAreas {
})
}
- /// Returns the value of any Issuer Fingerprint subpackets.
+ /// Returns the values of all Issuer Fingerprint subpackets.
///
/// The [Issuer Fingerprint subpacket] is used when processing a
/// signature to identify which certificate created the signature.
@@ -2897,7 +2897,7 @@ impl SubpacketAreas {
})
}
- /// Returns the value of all Notation Data subpackets with the
+ /// Returns the values of all Notation Data subpackets with the
/// given name.
///
/// [Notation Data subpackets] are key-value pairs. They can be
@@ -3486,7 +3486,7 @@ impl SubpacketAreas {
}
}
- /// Returns a reference to the Embedded Signature subpacket.
+ /// Returns references to all Embedded Signature subpackets.
///
/// The [Embedded Signature subpacket] is normally used to hold a
/// [Primary Key Binding signature], which binds a
@@ -3517,8 +3517,7 @@ impl SubpacketAreas {
})
}
- /// Returns a mutable reference to the Embedded Signature
- /// subpacket.
+ /// Returns mutable references to all Embedded Signature subpackets.
///
/// The [Embedded Signature subpacket] is normally used to hold a
/// [Primary Key Binding signature], which binds a