Skip to content

Commit

Permalink
Allow missing docs directly on derived error types
Browse files Browse the repository at this point in the history
  • Loading branch information
teor2345 committed Feb 15, 2023
1 parent 41ee0da commit b1565ac
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
3 changes: 3 additions & 0 deletions zebra-consensus/src/error.rs
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ use proptest_derive::Arbitrary;
const MAX_EXPIRY_HEIGHT: block::Height = block::Height::MAX_EXPIRY_HEIGHT;

#[derive(Error, Copy, Clone, Debug, PartialEq, Eq)]
#[allow(missing_docs)]
pub enum SubsidyError {
#[error("no coinbase transaction in block")]
NoCoinbase,
Expand All @@ -36,6 +37,7 @@ pub enum SubsidyError {

#[derive(Error, Clone, Debug, PartialEq, Eq)]
#[cfg_attr(any(test, feature = "proptest-impl"), derive(Arbitrary))]
#[allow(missing_docs)]
pub enum TransactionError {
#[error("first transaction must be coinbase")]
CoinbasePosition,
Expand Down Expand Up @@ -226,6 +228,7 @@ impl From<BoxError> for TransactionError {
}

#[derive(Error, Clone, Debug, PartialEq, Eq)]
#[allow(missing_docs)]
pub enum BlockError {
#[error("block contains invalid transactions")]
Transaction(#[from] TransactionError),
Expand Down
3 changes: 1 addition & 2 deletions zebra-consensus/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -40,11 +40,10 @@ mod config;
mod parameters;
mod primitives;
mod script;
pub mod transaction;

pub mod chain;
#[allow(missing_docs)]
pub mod error;
pub mod transaction;

pub use block::{
subsidy::{
Expand Down

0 comments on commit b1565ac

Please sign in to comment.