chain: touch up docs

This commit is contained in:
Henry de Valence 2020-08-15 21:55:28 -07:00
parent ce1e81b274
commit dcc1e19129
6 changed files with 9 additions and 8 deletions

View File

@ -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;

View File

@ -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.

View File

@ -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

View File

@ -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

View File

@ -1,4 +1,4 @@
//! Transaction types.
//! Transactions and transaction-related structures.
use serde::{Deserialize, Serialize};

View File

@ -1,4 +1,4 @@
//! Transparent (Bitcoin-inherited) functionality.
//! Transparent-related (Bitcoin-inherited) functionality.
mod address;
mod keys;