summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorNeal H. Walfield <neal@pep.foundation>2019-09-02 12:32:14 +0200
committerNeal H. Walfield <neal@pep.foundation>2019-09-02 13:32:05 +0200
commitdf4aaf8ab9c8689ca5d1dbd259e42d1ef3d2670b (patch)
tree617915dc06c76dc95e48aafd8533baf40f034734
parentd519d6fd2462472496f184a324facdd9fa2bd6f9 (diff)
openpgp: Fix documentation.
-rw-r--r--openpgp/src/tpk/mod.rs10
1 files changed, 5 insertions, 5 deletions
diff --git a/openpgp/src/tpk/mod.rs b/openpgp/src/tpk/mod.rs
index ef6c9045..c250cb48 100644
--- a/openpgp/src/tpk/mod.rs
+++ b/openpgp/src/tpk/mod.rs
@@ -905,13 +905,14 @@ impl<'a> Parse<'a, TPK> for TPK {
}
impl TPK {
- /// Returns a reference to the primary key.
+ /// Returns a reference to the primary key binding.
pub fn primary(&self) -> &PrimaryKeyBinding<key::PublicParts> {
&self.primary
}
- /// Returns the primary key's current self-signature and, if it
- /// belong to a user id, a reference to the `UserIDBinding`.
+ /// Returns the primary key's current self-signature and, if the
+ /// self-signature belongs to a user id (as opposed to a direct
+ /// signature), a reference to the `UserIDBinding`.
///
/// Normally, the primary key's current self-signature is the
/// primary user id's newest, non-revoked self-signature.
@@ -1572,8 +1573,7 @@ impl TPK {
/// Merges `other` into `self`.
///
- /// If `other` is a different key, then nothing is merged into
- /// `self`, but `self` is still canonicalized.
+ /// If `other` is a different key, then an error is returned.
pub fn merge(mut self, mut other: TPK) -> Result<Self> {
if self.primary().key().fingerprint()
!= other.primary().key().fingerprint()