Skip to content

Commit eb8a639

Browse files
committed
Document arbitrary and quickcheck features
1 parent 42b03b4 commit eb8a639

File tree

2 files changed

+8
-0
lines changed

2 files changed

+8
-0
lines changed

src/arbitrary.rs

+2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
#[cfg(feature = "arbitrary")]
2+
#[cfg_attr(docsrs, doc(cfg(feature = "arbitrary")))]
23
mod impl_arbitrary {
34
use crate::{IndexMap, IndexSet};
45
use arbitrary::{Arbitrary, Result, Unstructured};
@@ -35,6 +36,7 @@ mod impl_arbitrary {
3536
}
3637

3738
#[cfg(feature = "quickcheck")]
39+
#[cfg_attr(docsrs, doc(cfg(feature = "quickcheck")))]
3840
mod impl_quickcheck {
3941
use crate::{IndexMap, IndexSet};
4042
use alloc::boxed::Box;

src/lib.rs

+6
Original file line numberDiff line numberDiff line change
@@ -40,13 +40,19 @@
4040
//! to [`IndexMap`] and [`IndexSet`]. Alternative implementations for
4141
//! (de)serializing [`IndexMap`] as an ordered sequence are available in the
4242
//! [`map::serde_seq`] module.
43+
//! * `arbitrary`: Adds implementations for the [`arbitrary::Arbitrary`] trait
44+
//! to [`IndexMap`] and [`IndexSet`].
45+
//! * `quickcheck`: Adds implementations for the [`quickcheck::Arbitrary`] trait
46+
//! to [`IndexMap`] and [`IndexSet`].
4347
//!
4448
//! _Note: only the `std` feature is enabled by default._
4549
//!
4650
//! [feature flags]: https://doc.rust-lang.org/cargo/reference/manifest.html#the-features-section
4751
//! [`no_std`]: #no-standard-library-targets
4852
//! [`Serialize`]: `::serde::Serialize`
4953
//! [`Deserialize`]: `::serde::Deserialize`
54+
//! [`arbitrary::Arbitrary`]: `::arbitrary::Arbitrary`
55+
//! [`quickcheck::Arbitrary`]: `::quickcheck::Arbitrary`
5056
//!
5157
//! ### Alternate Hashers
5258
//!

0 commit comments

Comments
 (0)