From a214e606e01252720be72073269bf47256c87451 Mon Sep 17 00:00:00 2001 From: Markus Mayer Date: Fri, 10 May 2024 11:41:23 +0200 Subject: [PATCH] Update crate documentation comment --- src/lib.rs | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/src/lib.rs b/src/lib.rs index cf737d6..babdc9b 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,3 +1,5 @@ +//! # shortguid +//! //! Provides short, URL-safe UUID representations. //! //! ``` @@ -11,21 +13,18 @@ //! assert_ne!(from_uuid, random); //! ``` //! -//! # Create features +//! ## Create features //! //! Other crate features can also be useful beyond the version support: //! -//! * `serde` - adds the ability to serialize and deserialize a UUID using -//! `serde`. -//! * `borsh` - adds the ability to serialize and deserialize a UUID using -//! `borsh`. -//! * `arbitrary` - adds an `Arbitrary` trait implementation to `Uuid` for -//! fuzzing. +//! * `serde` - adds the ability to serialize and deserialize a UUID using `serde`. +//! * `borsh` - adds the ability to serialize and deserialize a UUID using `borsh`. +//! * `arbitrary` - adds an `Arbitrary` trait implementation to `Uuid` for fuzzing. //! * `random` - adds the ability to generate a random [`ShortGuid`]s. //! * `fast-rng` - uses a faster algorithm for generating random [`ShortGuid`]s. //! This feature requires more dependencies to compile, but is just as suitable for -//! [`ShortGuid`] as the default algorithm. Implies `random`. -//! * `bytemuck` - adds a `Pod` trait implementation to `Uuid` for byte manipulation +//! [`ShortGuid`] as the default algorithm. Implies `random`, enabled by default. +//! * `bytemuck` - adds a `Pod` trait implementation to `Uuid` for byte manipulation. // only enables the `doc_cfg` feature when // the `docsrs` configuration attribute is defined