Skip to content

Commit

Permalink
docs(iroh): document reexports
Browse files Browse the repository at this point in the history
  • Loading branch information
rklaehn committed Jul 5, 2024
1 parent f4d1e71 commit 1dcb48c
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion iroh/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,14 @@
//! **Important**: the protocol to a remote node is not stable and will
//! frequently change. So the client and server must be running the same version of iroh.
//!
//! ## Reexports
//!
//! The iroh crate re-exports the following crates:
//! - [iroh_base](iroh_base) as [`base`]
//! - [iroh_blobs](iroh_blobs) as [`blobs`]
//! - [iroh_docs](iroh_docs) as [`docs`]
//! - [iroh_net](iroh_net) as [`net`]
//!
//! ## Feature Flags
//!
//! - `metrics`: Enable metrics collection. Enabled by default.
Expand All @@ -82,7 +90,7 @@
#![cfg_attr(docsrs, feature(doc_cfg))]
#![deny(missing_docs, rustdoc::broken_intra_doc_links)]

// re-export the iroh crates
/// re-export the iroh crates
#[doc(inline)]
pub use iroh_base as base;
#[doc(inline)]
Expand Down

0 comments on commit 1dcb48c

Please sign in to comment.