mirror of
https://github.com/lightningdevkit/rust-lightning.git
synced 2025-01-18 21:34:48 +01:00
Enforce doc link correctness during cargo doc
runs and in CI
This commit is contained in:
parent
98c6566b01
commit
18a0967758
@ -1,3 +1,6 @@
|
||||
#![deny(broken_intra_doc_links)]
|
||||
#![deny(unsafe_code)]
|
||||
|
||||
#[macro_use] extern crate lightning;
|
||||
|
||||
use lightning::chain;
|
||||
|
@ -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
|
||||
|
@ -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;
|
||||
|
||||
|
@ -72,6 +72,9 @@
|
||||
//! }
|
||||
//! ```
|
||||
|
||||
#![deny(broken_intra_doc_links)]
|
||||
#![deny(missing_docs)]
|
||||
|
||||
use bitcoin::secp256k1::key::PublicKey;
|
||||
|
||||
use tokio::net::TcpStream;
|
||||
|
@ -1,3 +1,5 @@
|
||||
#![deny(broken_intra_doc_links)]
|
||||
|
||||
mod util;
|
||||
|
||||
extern crate lightning;
|
||||
|
@ -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
|
||||
|
Loading…
Reference in New Issue
Block a user