From cea006d6a5939eb6b95766b94e0182fd7e813322 Mon Sep 17 00:00:00 2001 From: GrayJack Date: Mon, 17 Feb 2025 22:19:02 -0300 Subject: [PATCH] docs: Rewords a few sentences --- src/lib.rs | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/src/lib.rs b/src/lib.rs index d7546f7..199d287 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -25,19 +25,23 @@ //! //! Here is a non-exhaustive list of the things that `rbitset` supports: //! -//! - `no_std` support: Can be used in environments without the standard library. +//! - `no_std` support. //! - Fixed-size: The size of the bitset is determined at compile time. //! - Efficient bit manipulation: Provides methods for setting, clearing, and testing bits. //! - Set operations: Supports union, intersection, difference, and symmetric difference as //! iterators. -//! - Serde support: Can be serialized and deserialized using the `serde` crate (with the `serde` -//! feature enabled). +//! - Opt- in `serde` support: [`BitSet`] can be serialized and deserialized using the `serde` crate +//! (with the `serde` feature enabled). +//! +//! Also, these sub-modules serve to provide longer form documentation: +//! +//! - [Changelog](crate::changelog) //! //! # Usage //! //! The `rbitset` project is [on crates.io](https://crates.io/crates/rbitset) and can be //! used by adding `rbitset` to your dependencies in your project's `Cargo.toml`. -//! Or more simply, just run `cargo add rbitset`. +//! Or more simply, by using `cargo add`. //! //! ```sh //! cargo add rbitset @@ -85,7 +89,6 @@ //! //! - **serde** — When enabled, `rbitset` will depend on the `serde` crate and the [`BitSet`] type //! will implement the `Serialize` and `Deserialize` traits. - #![no_std] #![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]