From dcc1e19129f8b2d980f0d11e35049dd1e2704470 Mon Sep 17 00:00:00 2001
From: Henry de Valence <hdevalence@hdevalence.ca>
Date: Sat, 15 Aug 2020 21:55:28 -0700
Subject: [PATCH] chain: touch up docs

---
 zebra-chain/src/lib.rs           | 7 ++++---
 zebra-chain/src/parameters.rs    | 2 +-
 zebra-chain/src/primitives.rs    | 2 +-
 zebra-chain/src/serialization.rs | 2 +-
 zebra-chain/src/transaction.rs   | 2 +-
 zebra-chain/src/transparent.rs   | 2 +-
 6 files changed, 9 insertions(+), 8 deletions(-)

diff --git a/zebra-chain/src/lib.rs b/zebra-chain/src/lib.rs
index fc873395..79fcc9b2 100644
--- a/zebra-chain/src/lib.rs
+++ b/zebra-chain/src/lib.rs
@@ -1,12 +1,13 @@
-//! Blockchain-related datastructures for Zebra. 🦓
+//! Core Zcash data structures. 🦓
 //!
-//! $$a^2 + b^2 = c^2$$
+//! This crate provides definitions of core datastructures for Zcash, such as
+//! blocks, transactions, addresses, etc.
 
 #![doc(html_favicon_url = "https://www.zfnd.org/images/zebra-favicon-128.png")]
 #![doc(html_logo_url = "https://www.zfnd.org/images/zebra-icon.png")]
 #![doc(html_root_url = "https://doc.zebra.zfnd.org/zebra_chain")]
-//#![deny(missing_docs)]
 #![allow(clippy::try_err)]
+#![deny(missing_docs)]
 
 #[macro_use]
 extern crate serde;
diff --git a/zebra-chain/src/parameters.rs b/zebra-chain/src/parameters.rs
index 9c614fbc..f1f70123 100644
--- a/zebra-chain/src/parameters.rs
+++ b/zebra-chain/src/parameters.rs
@@ -1,4 +1,4 @@
-//! The consensus parameters for each Zcash network.
+//! Consensus parameters for each Zcash network.
 //!
 //! This module contains the consensus parameters which are required for
 //! parsing.
diff --git a/zebra-chain/src/primitives.rs b/zebra-chain/src/primitives.rs
index 6838dd00..01226727 100644
--- a/zebra-chain/src/primitives.rs
+++ b/zebra-chain/src/primitives.rs
@@ -1,4 +1,4 @@
-//! Primitives used in Zcash structures.
+//! External primitives used in Zcash structures.
 //!
 //! This contains re-exports of libraries used in the public API, as well as stub
 //! definitions of primitive types which must be represented in this library but
diff --git a/zebra-chain/src/serialization.rs b/zebra-chain/src/serialization.rs
index 8d17ae21..89046e0f 100644
--- a/zebra-chain/src/serialization.rs
+++ b/zebra-chain/src/serialization.rs
@@ -1,4 +1,4 @@
-//! Serialization for Zcash.
+//! Consensus-critical serialization.
 //!
 //! This module contains four traits: `ZcashSerialize` and `ZcashDeserialize`,
 //! analogs of the Serde `Serialize` and `Deserialize` traits but intended for
diff --git a/zebra-chain/src/transaction.rs b/zebra-chain/src/transaction.rs
index d8d59744..1f58c8a6 100644
--- a/zebra-chain/src/transaction.rs
+++ b/zebra-chain/src/transaction.rs
@@ -1,4 +1,4 @@
-//! Transaction types.
+//! Transactions and transaction-related structures.
 
 use serde::{Deserialize, Serialize};
 
diff --git a/zebra-chain/src/transparent.rs b/zebra-chain/src/transparent.rs
index d79b701a..bce9989f 100644
--- a/zebra-chain/src/transparent.rs
+++ b/zebra-chain/src/transparent.rs
@@ -1,4 +1,4 @@
-//! Transparent (Bitcoin-inherited) functionality.
+//! Transparent-related (Bitcoin-inherited) functionality.
 
 mod address;
 mod keys;