summaryrefslogtreecommitdiffstats
path: root/openpgp/src/crypto/mod.rs
diff options
context:
space:
mode:
authorJustus Winter <justus@sequoia-pgp.org>2020-08-04 16:22:53 +0200
committerJustus Winter <justus@sequoia-pgp.org>2020-08-04 16:42:33 +0200
commitc9d4d70b94c8440c8cb74e2dedffa8d8dc214866 (patch)
tree4dabb82a59a834f1249aee1610e74dad5ed7d271 /openpgp/src/crypto/mod.rs
parent7ac4d250914ba4349614a860ff2a7635ba704936 (diff)
openpgp: Improve documentation of mod asymmetric.
- See #474.
Diffstat (limited to 'openpgp/src/crypto/mod.rs')
-rw-r--r--openpgp/src/crypto/mod.rs2
1 files changed, 2 insertions, 0 deletions
diff --git a/openpgp/src/crypto/mod.rs b/openpgp/src/crypto/mod.rs
index c4ea6ab8..eccd1b7c 100644
--- a/openpgp/src/crypto/mod.rs
+++ b/openpgp/src/crypto/mod.rs
@@ -13,9 +13,11 @@
//!
//! - *Converting a string to a `Password`*: Use [`Password::from`].
//! - *Create a session key*: Use [`SessionKey::new`].
+//! - *Use secret keys*: See the [`KeyPair` example].
//!
//! [`Password::from`]: https://doc.rust-lang.org/std/convert/trait.From.html
//! [`SessionKey::new`]: struct.SessionKey.html#method.new
+//! [`KeyPair` example]: struct.KeyPair.html#examples
use std::io::Read;
use std::ops::{Deref, DerefMut};