Enforce doc link correctness during cargo doc runs and in CI

This commit is contained in:
Matt Corallo 2021-03-17 14:05:09 -04:00
parent 98c6566b01
commit 18a0967758
6 changed files with 13 additions and 0 deletions

View File

@ -1,3 +1,6 @@
#![deny(broken_intra_doc_links)]
#![deny(unsafe_code)]
#[macro_use] extern crate lightning;
use lightning::chain;

View File

@ -3,4 +3,5 @@ set -e
set -x
echo Testing $(git log -1 --oneline)
cargo check
cargo doc
cd fuzz && cargo check --features=stdin_fuzz

View File

@ -16,6 +16,9 @@
//! [`SpvClient`]: struct.SpvClient.html
//! [`BlockSource`]: trait.BlockSource.html
#![deny(broken_intra_doc_links)]
#![deny(unsafe_code)]
#[cfg(any(feature = "rest-client", feature = "rpc-client"))]
pub mod http;

View File

@ -72,6 +72,9 @@
//! }
//! ```
#![deny(broken_intra_doc_links)]
#![deny(missing_docs)]
use bitcoin::secp256k1::key::PublicKey;
use tokio::net::TcpStream;

View File

@ -1,3 +1,5 @@
#![deny(broken_intra_doc_links)]
mod util;
extern crate lightning;

View File

@ -20,6 +20,7 @@
#![cfg_attr(not(any(feature = "fuzztarget", feature = "_test_utils")), deny(missing_docs))]
#![cfg_attr(not(any(test, feature = "fuzztarget", feature = "_test_utils")), forbid(unsafe_code))]
#![deny(broken_intra_doc_links)]
// In general, rust is absolutely horrid at supporting users doing things like,
// for example, compiling Rust code for real environments. Disable useless lints