Skip to content

Commit

Permalink
Update crate documentation comment
Browse files Browse the repository at this point in the history
  • Loading branch information
sunsided committed May 10, 2024
1 parent 0067a52 commit a214e60
Showing 1 changed file with 8 additions and 9 deletions.
17 changes: 8 additions & 9 deletions src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
//! # shortguid
//!
//! Provides short, URL-safe UUID representations.
//!
//! ```
Expand All @@ -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
Expand Down

0 comments on commit a214e60

Please sign in to comment.