From 556f37168978ef807034cca2c4338714431a6fe0 Mon Sep 17 00:00:00 2001
From: Andy Gauge <andygauge@gmail.com>
Date: Fri, 27 Oct 2017 16:59:36 -0700
Subject: [PATCH] Error documentation improvement

---
 openssl/src/error.rs | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

diff --git a/openssl/src/error.rs b/openssl/src/error.rs
index 9151c01b6..e565c2723 100644
--- a/openssl/src/error.rs
+++ b/openssl/src/error.rs
@@ -1,3 +1,20 @@
+//! Errors returned by OpenSSL library.
+//!
+//! OpenSSL errors are stored in an `ErrorStack`.  Most methods in the crate
+/// returns a `Result<T, ErrorStack>` type.
+//!
+//! # Examples
+//!
+//! ```
+//! use openssl::error::ErrorStack;
+//! use openssl::bn::BigNum;
+//!
+//! let an_error = BigNum::from_dec_str("Cannot parse letters");
+//! match an_error {
+//!     Ok(_)  => _,
+//!     Err(e) => println!("Parsing Error: {:?}", e),
+//! }
+//! ```
 use libc::{c_ulong, c_char, c_int};
 use std::fmt;
 use std::error;
@@ -9,6 +26,9 @@ use std::borrow::Cow;
 
 use ffi;
 
+/// Collection of [`Error`]s from OpenSSL.
+///
+/// [`Error`]: struct.Error.html
 #[derive(Debug, Clone)]
 pub struct ErrorStack(Vec<Error>);
 
-- 
GitLab