From dd17ba05d0a76e2a4e03d8c7b0aabd8d1beb5915 Mon Sep 17 00:00:00 2001 From: Nick Mathewson Date: Fri, 8 May 2020 00:05:49 -0400 Subject: [PATCH] llcrypto: small documentation improvements --- tor-llcrypto/src/lib.rs | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/tor-llcrypto/src/lib.rs b/tor-llcrypto/src/lib.rs index 28cbaaa66..46f85444b 100644 --- a/tor-llcrypto/src/lib.rs +++ b/tor-llcrypto/src/lib.rs @@ -1,14 +1,18 @@ -//! This crate wraps other crates that implement lower-level -//! cryptographic functionality that Tor does not implement itself. -//! In some cases the functionality is just re-exported; in others, it -//! is wrapped to present a conseistent interface. +//! Low-level crypto implementations for Tor. +//! +//! This crate doesn't have anything interesting: it just wraps other +//! crates that implement lower-level cryptographic functionality that +//! Tor does not implement itself. In some cases the functionality is +//! just re-exported; in others, it is wrapped to present a +//! conseistent interface. //! //! Encryption is implemented in `cipher`, digests are in `d`, and //! public key cryptography (including signatures, encryption, and key //! agreement) are in `pk`. //! -//! When possible, everything here should be accessed via traits from -//! the rust-crypto project, as re-exported from the traits module. +//! When possible, everything here should be accessed via traits. +//! We're using traits from the rust-crypto project, as +//! re-exported from the traits module. // TODO -- the long-term intention here is that this functionality // should be replaceable at compile time with other implementations.