Slight doc updates.

bodil · Dec 16, 2019 · 99712ff · 99712ff
1 parent d5b6e0c
commit 99712ff
Show file tree

Hide file tree

Showing 6 changed files with 11 additions and 3 deletions.
diff --git a/src/hash/map.rs b/src/hash/map.rs
@@ -2027,6 +2027,7 @@ impl<K: Hash + Eq + Arbitrary + Sync, V: Arbitrary + Sync> Arbitrary for HashMap
 
 #[cfg(any(test, feature = "proptest"))]
 pub mod proptest {
+    //! Proptest strategies.
     use super::*;
     use ::proptest::strategy::{BoxedStrategy, Strategy, ValueTree};
     use std::ops::Range;

diff --git a/src/hash/set.rs b/src/hash/set.rs
@@ -1066,6 +1066,7 @@ where
 
 #[cfg(any(test, feature = "proptest"))]
 pub mod proptest {
+    //! Proptest strategies.
     use super::*;
     use ::proptest::strategy::{BoxedStrategy, Strategy, ValueTree};
     use std::ops::Range;

diff --git a/src/lib.rs b/src/lib.rs
@@ -303,10 +303,11 @@
 //!
 //! | Feature | Description |
 //! | ------- | ----------- |
+//! | [`pool`](https://crates.io/crates/refpool) | Constructors and pool types for [`refpool`](https://crates.io/crates/refpool) memory pools (recommended only for `im-rc`) |
 //! | [`proptest`](https://crates.io/crates/proptest) | Strategies for all `im` datatypes under a `proptest` namespace, eg. `im::vector::proptest::vector()` |
-//! | [`quickcheck`](https://crates.io/crates/quickcheck) | `Arbitrary` implementations for all `im` datatypes (not available in `im-rc`) |
-//! | [`rayon`](https://crates.io/crates/rayon) | parallel iterator implementations for `Vector` (not available in `im-rc`) |
-//! | [`serde`](https://crates.io/crates/serde) | `Serialize` and `Deserialize` implementations for all `im` datatypes |
+//! | [`quickcheck`](https://crates.io/crates/quickcheck) | [`Arbitrary`](https://docs.rs/quickcheck/latest/quickcheck/trait.Arbitrary.html) implementations for all `im` datatypes (not available in `im-rc`) |
+//! | [`rayon`](https://crates.io/crates/rayon) | parallel iterator implementations for [`Vector`][vector::Vector] (not available in `im-rc`) |
+//! | [`serde`](https://crates.io/crates/serde) | [`Serialize`](https://docs.rs/serde/latest/serde/trait.Serialize.html) and [`Deserialize`](https://docs.rs/serde/latest/serde/trait.Deserialize.html) implementations for all `im` datatypes |
 //!
 //! [std::collections]: https://doc.rust-lang.org/std/collections/index.html
 //! [std::collections::VecDeque]: https://doc.rust-lang.org/std/collections/struct.VecDeque.html
@@ -364,6 +365,7 @@ pub mod vector;
 pub mod iter;
 
 #[cfg(any(test, feature = "serde"))]
+#[doc(hidden)]
 pub mod ser;
 
 #[cfg(not(feature = "pool"))]

diff --git a/src/ord/map.rs b/src/ord/map.rs
@@ -1950,6 +1950,7 @@ impl<K: Ord + Clone + Arbitrary + Sync, V: Clone + Arbitrary + Sync> Arbitrary f
 
 #[cfg(any(test, feature = "proptest"))]
 pub mod proptest {
+    //! Proptest strategies.
     use super::*;
     use ::proptest::strategy::{BoxedStrategy, Strategy, ValueTree};
     use std::ops::Range;

diff --git a/src/ord/set.rs b/src/ord/set.rs
@@ -1129,6 +1129,7 @@ impl<A: Ord + Clone + Arbitrary + Sync> Arbitrary for OrdSet<A> {
 
 #[cfg(any(test, feature = "proptest"))]
 pub mod proptest {
+    //! Proptest strategies.
     use super::*;
     use ::proptest::strategy::{BoxedStrategy, Strategy, ValueTree};
     use std::ops::Range;

diff --git a/src/vector/mod.rs b/src/vector/mod.rs
@@ -2196,6 +2196,7 @@ impl<'a, A: Clone> FusedIterator for ChunksMut<'a, A> {}
 
 #[cfg(all(threadsafe, any(test, feature = "rayon")))]
 pub mod rayon {
+    //! Parallel iterators.
     use super::*;
 
     use ::rayon::iter::plumbing::{
@@ -2418,6 +2419,7 @@ impl<A: Arbitrary + Sync + Clone> Arbitrary for Vector<A> {
 
 #[cfg(any(test, feature = "proptest"))]
 pub mod proptest {
+    //! Proptest strategies.
     use super::*;
     use ::proptest::collection::vec;
     use ::proptest::strategy::{BoxedStrategy, Strategy, ValueTree};