From ef33c224d80445f15673198587d6ab462f1cef31 Mon Sep 17 00:00:00 2001 From: Justus Winter Date: Fri, 31 Jul 2020 14:13:52 +0200 Subject: openpgp: Improve documentation of crypto::Password. - See #474. --- openpgp/src/crypto/mod.rs | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/openpgp/src/crypto/mod.rs b/openpgp/src/crypto/mod.rs index d3abcbf3..856fc6a7 100644 --- a/openpgp/src/crypto/mod.rs +++ b/openpgp/src/crypto/mod.rs @@ -134,10 +134,12 @@ impl fmt::Debug for SessionKey { /// Holds a password. /// +/// `Password`s can be converted from various types using [`From`]. /// The password is encrypted in memory and only decrypted on demand. /// See [`mem::Encrypted`] for details. /// -/// [`mem::Encrypted`]: mem/struct.Encrypted.html +/// [`From`]: https://doc.rust-lang.org/std/convert/trait.From.html +/// [`mem::Encrypted`]: mem/struct.Encrypted.html #[derive(Clone, PartialEq, Eq)] pub struct Password(mem::Encrypted); -- cgit v1.2.3