Skip to content

Commit

Permalink
fix(doc): rename doc_cfg guard to docsrs, rust-lang/cargo#13875
Browse files Browse the repository at this point in the history
  • Loading branch information
zvolin committed May 7, 2024
1 parent fa3c164 commit bbc934a
Show file tree
Hide file tree
Showing 6 changed files with 10 additions and 11 deletions.
2 changes: 1 addition & 1 deletion node/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -102,4 +102,4 @@ test-utils = ["celestia-types/test-utils"]

[package.metadata.docs.rs]
features = ["test-utils"]
rustdoc-args = ["--cfg", "docs_rs"]
rustdoc-args = ["--cfg", "docsrs"]
4 changes: 2 additions & 2 deletions node/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#![cfg_attr(docs_rs, feature(doc_cfg))]
#![cfg_attr(docsrs, feature(doc_cfg))]
#![doc = include_str!("../README.md")]

pub mod blockstore;
Expand All @@ -11,7 +11,7 @@ pub mod peer_tracker;
pub mod store;
pub mod syncer;
#[cfg(any(test, feature = "test-utils"))]
#[cfg_attr(docs_rs, doc(cfg(feature = "test-utils")))]
#[cfg_attr(docsrs, doc(cfg(feature = "test-utils")))]
pub mod test_utils;
mod utils;

Expand Down
2 changes: 1 addition & 1 deletion rpc/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -54,4 +54,4 @@ wasm-bindgen = ["celestia-types/wasm-bindgen"]

[package.metadata.docs.rs]
features = ["p2p"]
rustdoc-args = ["--cfg", "docs_rs"]
rustdoc-args = ["--cfg", "docsrs"]
4 changes: 2 additions & 2 deletions rpc/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#![cfg_attr(docs_rs, feature(doc_cfg))]
#![cfg_attr(docsrs, feature(doc_cfg))]
#![doc = include_str!("../README.md")]

mod blob;
Expand All @@ -16,7 +16,7 @@ pub use crate::client::Client;
pub use crate::error::{Error, Result};
pub use crate::header::HeaderClient;
#[cfg(feature = "p2p")]
#[cfg_attr(docs_rs, doc(cfg(feature = "p2p")))]
#[cfg_attr(docsrs, doc(cfg(feature = "p2p")))]
pub use crate::p2p::P2PClient;
pub use crate::share::ShareClient;
pub use crate::state::StateClient;
Expand Down
3 changes: 1 addition & 2 deletions types/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,7 @@ test-utils = ["dep:ed25519-consensus", "dep:rand"]
wasm-bindgen = ["celestia-tendermint/wasm-bindgen"]

[package.metadata.docs.rs]
features = ["p2p", "test-utils"]
rustdoc-args = ["--cfg", "docs_rs"]
rustdoc-args = ["--cfg", "docsrs"]

[package.metadata.cargo-udeps.ignore]
development = ["indoc"]
6 changes: 3 additions & 3 deletions types/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#![cfg_attr(docs_rs, feature(doc_cfg))]
#![cfg_attr(docsrs, feature(doc_cfg))]
#![doc = include_str!("../README.md")]

pub mod blob;
Expand All @@ -13,7 +13,7 @@ pub mod hash;
pub mod namespaced_data;
pub mod nmt;
#[cfg(feature = "p2p")]
#[cfg_attr(docs_rs, doc(cfg(feature = "p2p")))]
#[cfg_attr(docsrs, doc(cfg(feature = "p2p")))]
pub mod p2p;
pub mod row;
mod rsmt2d;
Expand All @@ -22,7 +22,7 @@ mod share;
pub mod state;
mod sync;
#[cfg(any(test, feature = "test-utils"))]
#[cfg_attr(docs_rs, doc(cfg(feature = "test-utils")))]
#[cfg_attr(docsrs, doc(cfg(feature = "test-utils")))]
pub mod test_utils;
pub mod trust_level;
mod validate;
Expand Down

0 comments on commit bbc934a

Please sign in to comment.