From 080c8f18e22d4f677e61c52aca0e62f067e7c073 Mon Sep 17 00:00:00 2001
From: Adam Wick <awick@uhsure.com>
Date: Mon, 27 May 2019 20:48:56 -0700
Subject: [PATCH] Update some top-level documentation.

---
 src/lib.rs | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/src/lib.rs b/src/lib.rs
index c132603..5af320d 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -45,10 +45,17 @@ pub mod ssh;
 /// used by TLS and others.
 pub mod x509;
 
+/// A generic trait for defining what a key pair looks like. This is useful
+/// in a couple places in which we want to define code regardless of the
+/// kind of key it is, but is unlikely to be hugely useful to users of the
+/// library.
 pub trait KeyPair {
+    /// The type of the public key of this pair.
     type Public;
+    /// The type of the private key of this pair.
     type Private;
 
+    /// Generate a key pair given the provided public and private keys.
     fn new(pbl: Self::Public, prv: Self::Private) -> Self;
 }