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 1/2] 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 9151c01b..e565c272 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>);
 

From 829c805543b8ef4400857b57a99a9405723f6367 Mon Sep 17 00:00:00 2001
From: AndyGauge <andygauge@gmail.com>
Date: Sat, 4 Nov 2017 12:24:24 -0700
Subject: [PATCH 2/2] fixed broken example and syntax error in module level
 documentation

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

diff --git a/openssl/src/error.rs b/openssl/src/error.rs
index e565c272..5f3e2170 100644
--- a/openssl/src/error.rs
+++ b/openssl/src/error.rs
@@ -1,7 +1,7 @@
 //! Errors returned by OpenSSL library.
 //!
 //! OpenSSL errors are stored in an `ErrorStack`.  Most methods in the crate
-/// returns a `Result<T, ErrorStack>` type.
+//! returns a `Result<T, ErrorStack>` type.
 //!
 //! # Examples
 //!
@@ -11,7 +11,7 @@
 //!
 //! let an_error = BigNum::from_dec_str("Cannot parse letters");
 //! match an_error {
-//!     Ok(_)  => _,
+//!     Ok(_)  => (),
 //!     Err(e) => println!("Parsing Error: {:?}", e),
 //! }
 //! ```