From 3d0ad24698b0d3ec9e43114aa3110d6b28f720df Mon Sep 17 00:00:00 2001
From: Justus Winter <justus@sequoia-pgp.org>
Date: Wed, 2 Jan 2019 14:56:58 +0100
Subject: openpgp: Improve documentation.

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

(limited to 'openpgp')

diff --git a/openpgp/src/crypto/asymmetric.rs b/openpgp/src/crypto/asymmetric.rs
index 9a497f9a..9c8a1ae6 100644
--- a/openpgp/src/crypto/asymmetric.rs
+++ b/openpgp/src/crypto/asymmetric.rs
@@ -7,6 +7,11 @@ use constants::HashAlgorithm;
 use Result;
 
 /// Creates a signature.
+///
+/// This is a low-level mechanism to produce an arbitrary OpenPGP
+/// signature.  Using this trait allows Sequoia to perform all
+/// operations involving signing to use a variety of secret key
+/// storage mechanisms (e.g. smart cards).
 pub trait Signer {
     /// Returns a reference to the public key.
     fn public(&self) -> &Key;
-- 
cgit v1.2.3