From 4c61e4c5caa421ace06733630bda85b19579946a Mon Sep 17 00:00:00 2001
From: Justus Winter <justus@sequoia-pgp.org>
Date: Wed, 2 Jan 2019 16:58:46 +0100
Subject: openpgp: Improve documentation.

---
 openpgp/src/crypto/asymmetric.rs | 6 ++++++
 1 file changed, 6 insertions(+)

(limited to 'openpgp/src/crypto/asymmetric.rs')

diff --git a/openpgp/src/crypto/asymmetric.rs b/openpgp/src/crypto/asymmetric.rs
index 51d95934..b779176a 100644
--- a/openpgp/src/crypto/asymmetric.rs
+++ b/openpgp/src/crypto/asymmetric.rs
@@ -25,6 +25,12 @@ pub trait Signer {
 }
 
 /// A cryptographic key pair.
+///
+/// A `KeyPair` is a combination of public and secret key.  If both
+/// are available in memory, a `KeyPair` is a convenient
+/// implementation of [`Signer`].
+///
+/// [`Signer`]: trait.Signer.html
 pub struct KeyPair {
     public: Key,
     secret: mpis::SecretKey,
-- 
cgit v1.2.3