Merge pull request #3596 from davidhewitt/smallvec-docs

docs: fixup docs for smallvec feature
PyO3 · Nov 25, 2023 · cbd0630 · cbd0630
2 parents 31b871a + bead83f
commit cbd0630
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git a/guide/src/features.md b/guide/src/features.md
@@ -159,3 +159,7 @@ struct User {
 }
 # }
 ```
+
+### `smallvec`
+
+Adds a dependency on [smallvec](https://docs.rs/smallvec) and enables conversions into its [`SmallVec`](https://docs.rs/smallvec/latest/smallvec/struct.SmallVec.html) type.
diff --git a/src/lib.rs b/src/lib.rs
@@ -85,7 +85,6 @@
 //! - [`eyre`]: Enables a conversion from [eyre]’s [`Report`] type to [`PyErr`].
 //! - [`hashbrown`]: Enables conversions between Python objects and [hashbrown]'s [`HashMap`] and
 //! [`HashSet`] types.
-//! - [`smallvec`][smallvec]: Enables conversions between Python list and [smallvec]'s [`SmallVec`].
 //! - [`indexmap`][indexmap_feature]: Enables conversions between Python dictionary and [indexmap]'s [`IndexMap`].
 //! - [`num-bigint`]: Enables conversions between Python objects and [num-bigint]'s [`BigInt`] and
 //! [`BigUint`] types.
@@ -95,6 +94,7 @@
 //! [`Decimal`] type.
 //! - [`serde`]: Allows implementing [serde]'s [`Serialize`] and [`Deserialize`] traits for
 //! [`Py`]`<T>` for all `T` that implement [`Serialize`] and [`Deserialize`].
+//! - [`smallvec`][smallvec]: Enables conversions between Python list and [smallvec]'s [`SmallVec`].
 //!
 //! ## Unstable features
 //!
-Original file line number
+Diff line change
@@ Expand Up / @@ -159,3 +159,7 @@ struct User { @@
     }
     # }
     ```
+    ### `smallvec`
+    Adds a dependency on [smallvec](https://docs.rs/smallvec) and enables conversions into its [`SmallVec`](https://docs.rs/smallvec/latest/smallvec/struct.SmallVec.html) type.