Improve module level docs

Improve module level docs (inner docs) by doing:

- Remove markdown
- Use full sentence
- Uniformly use trailing `!//` (blank line)

Author: tcharding

src/error.rs

@@ -12,7 +12,7 @@
 // If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.
 //
 
-//! # Error Type
+//! Crate error type.
 //!
 
 use core::fmt;

src/hash160.rs

@@ -17,7 +17,8 @@
 // was written entirely by Andrew Poelstra, who is re-licensing its
 // contents here as CC0.
 
-//! # HASH160 (SHA256 then RIPEMD160)
+//! HASH160 (SHA256 then RIPEMD160) implementation.
+//!
 
 use core::str;
 use core::ops::Index;

src/hex.rs

@@ -12,7 +12,7 @@
 // If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.
 //
 
-//! # Hex encoding and decoding
+//! Hex encoding and decoding.
 //!
 
 #[cfg(any(feature = "std", feature = "alloc"))]

src/hmac.rs

@@ -17,7 +17,8 @@
 // was written entirely by Andrew Poelstra, who is re-licensing its
 // contents here as CC0.
 
-//! # HMAC support
+//! Hash-based Message Authentication Code (HMAC).
+//!
 
 use core::{borrow, fmt, ops, str};
 #[cfg(feature = "serde")]

src/impls.rs

@@ -14,7 +14,8 @@
 
 //! `std` / `core2` Impls
 //!
-//! impls of traits defined in `std` / `core2` and not in `core`
+//! Implementations of traits defined in `std` / `core2` and not in `core`.
+//!
 
 #[cfg(feature = "std")]
 use std::{error, io};

src/lib.rs

@@ -12,7 +12,7 @@
 // If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.
 //
 
-//! # Rust Hashes Library
+//! Rust hashes library.
 //!
 //! This is a simple, no-dependency library which implements the hash functions
 //! needed by Bitcoin. These are SHA256, SHA256d, and RIPEMD160. As an ancillary

src/ripemd160.rs

@@ -17,7 +17,8 @@
 // was written entirely by Andrew Poelstra, who is re-licensing its
 // contents here as CC0.
 
-//! # RIPEMD160
+//! RIPEMD160 implementation.
+//!
 
 use core::{cmp, str};
 use core::ops::Index;

src/serde_macros.rs

@@ -12,7 +12,8 @@
 // If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.
 //
 
-//! Macros for serde trait impls, and supporting code
+//! Macros for serde trait implementations, and supporting code.
+//!
 
 #[cfg(feature = "serde")]
 /// Functions used by serde impls of all hashes

src/sha1.rs

@@ -12,7 +12,8 @@
 // If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.
 //
 
-//! # SHA1
+//! SHA1 implementation.
+//!
 
 use core::{cmp, str};
 use core::ops::Index;

src/sha256.rs

@@ -12,7 +12,8 @@
 // If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.
 //
 
-//! # SHA256
+//! SHA256 implementation.
+//!
 
 use core::{cmp, str};
 use core::ops::Index;