Index: Cargo.toml ================================================================== --- Cargo.toml +++ Cargo.toml @@ -1,8 +1,8 @@ [package] name = "schmoozer" -version = "0.1.1" +version = "0.1.2" edition = "2021" license = "0BSD" keywords = [ "connector", "network", "tokio" ] repository = "https://repos.qrnch.tech/pub/schmoozer" description = "A simple abstraction over a retryable async operation" Index: src/lib.rs ================================================================== --- src/lib.rs +++ src/lib.rs @@ -26,11 +26,14 @@ //! Likewise, the `run()` method returns its `Result<(), Self::Error>` wrapped //! in a `ControlFlow::Continue(_)` to indicate that the connector look should //! reconnect, while `ControlFlow::Break(_)` signals that a fatal error occured //! and the connect loop should terminate. +#![cfg_attr(docsrs, feature(doc_cfg))] + #[cfg(feature = "tcpconn")] +#[cfg_attr(docsrs, doc(cfg(feature = "tcpconn")))] pub mod tcpconn; use std::ops::ControlFlow; pub use async_trait::async_trait; Index: www/changelog.md ================================================================== --- www/changelog.md +++ www/changelog.md @@ -1,18 +1,28 @@ # Change Log ## [Unreleased] -[Details](/vdiff?from=schmoozer-0.1.0&to=trunk) +[Details](/vdiff?from=schmoozer-0.1.2&to=trunk) ### Added ### Changed ### Removed --- -## [0.1.0] - 2024-03-01 +## [0.1.2] - 2024-03-02 + +[Details](/vdiff?from=schmoozer-0.1.1&to=schmoozer-0.1.2) + +### Changed + +- Enable `docsrs` feature labels + +--- + +## [0.1.1] - 2024-03-01 Initial release. Index: www/index.md ================================================================== --- www/index.md +++ www/index.md @@ -1,5 +1,23 @@ # schmoozer A simple abstraction over a retryable async operation, such as establishing a TCP connection. + +## Feature labels in documentation + +The crate's documentation uses automatically generated feature labels, which +currently requires nightly featuers. To build the documentation locally use: + +``` +$ RUSTFLAGS="--cfg docsrs" RUSTDOCFLAGS="--cfg docsrs" \ +cargo +nightly doc --all-features +``` + + +## Change log + +The details of changes can always be found in the timeline, but for a +high-level view of changes between released versions there's a manually +maintained [Change Log](./changelog.md). +