Skip to content

Commit ad338d5

Browse files
committed
Update the feature documentation
* Update the document-features dependency to version 0.2.11. * Add links to the external dependencies.
1 parent 23aab78 commit ad338d5

File tree

2 files changed

+17
-15
lines changed

2 files changed

+17
-15
lines changed

Cargo.lock

Lines changed: 4 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

serde_with/Cargo.toml

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,8 @@ guide = ["dep:document-features", "macros", "std"]
5757
#! These features are disabled by default to minimize the number of required dependencies.
5858

5959
## The feature enables serializing data in base64 format.
60+
##
61+
## This pulls in [`base64`] as a dependency.
6062
base64 = ["dep:base64", "alloc"]
6163
## Deprecated feature name. Use `chrono_0_4` instead.
6264
chrono = ["chrono_0_4"]
@@ -65,23 +67,23 @@ chrono = ["chrono_0_4"]
6567
## More features are available in combination with `alloc` or `std`.
6668
## The legacy feature name `chrono` is still available for v1 compatibility.
6769
##
68-
## This pulls in `chrono` v0.4 as a dependency.
70+
## This pulls in [`chrono` v0.4](::chrono_0_4) as a dependency.
6971
chrono_0_4 = ["dep:chrono_0_4"]
7072
## The feature enables `hashbrown::{HashMap, HashSet}` as supported containers.
7173
##
72-
## This pulls in `hashbrown` v0.14 as a dependency.
74+
## This pulls in [`hashbrown` v0.14](::hashbrown_0_14) as a dependency.
7375
## It enables the `alloc` feature.
7476
## Some functionality is only available when `std` is enabled too.
7577
hashbrown_0_14 = ["dep:hashbrown_0_14", "alloc"]
7678
## The feature enables `hashbrown::{HashMap, HashSet}` as supported containers.
7779
##
78-
## This pulls in `hashbrown` v0.15 as a dependency.
80+
## This pulls in [`hashbrown` v0.15](::hashbrown_0_15) as a dependency.
7981
## It enables the `alloc` feature.
8082
## Some functionality is only available when `std` is enabled too.
8183
hashbrown_0_15 = ["dep:hashbrown_0_15", "alloc"]
8284
## The feature enables serializing data in hex format.
8385
##
84-
## This pulls in `hex` as a dependency.
86+
## This pulls in [`hex`] as a dependency.
8587
## It enables the `alloc` feature.
8688
hex = ["dep:hex", "alloc"]
8789
## Deprecated feature name. Use `indexmap_1` instead.
@@ -90,45 +92,45 @@ indexmap = ["indexmap_1"]
9092
## This includes support for checking duplicate keys and duplicate values.
9193
## The legacy feature name `indexmap` is still available for v1 compatibility.
9294
##
93-
## This pulls in `indexmap` v1 as a dependency.
95+
## This pulls in [`indexmap` v1](::indexmap_1) as a dependency.
9496
## It enables the `alloc` feature.
9597
## Some functionality is only available when `std` is enabled too.
9698
indexmap_1 = ["dep:indexmap_1", "alloc"]
9799
## The feature enables implementations of `indexmap` v2 specific checks.
98100
## This includes support for checking duplicate keys and duplicate values.
99101
##
100-
## This pulls in `indexmap` v2 as a dependency.
102+
## This pulls in [`indexmap` v2](::indexmap_2) as a dependency.
101103
## It enables the `alloc` feature.
102104
## Some functionality is only available when `std` is enabled too.
103105
indexmap_2 = ["dep:indexmap_2", "alloc"]
104106
## The feature enables JSON conversions from the `json` module.
105107
##
106-
## This pulls in `serde_json` as a dependency.
108+
## This pulls in [`serde_json`] as a dependency.
107109
## It enables the `alloc` feature.
108110
json = ["dep:serde_json", "alloc"]
109111
## The feature enables all helper macros and derives.
110112
## It is enabled by default, since the macros provide a usability benefit, especially for `serde_as`.
111113
##
112-
## This pulls in `serde_with_macros` as a dependency.
114+
## This pulls in [`serde_with_macros`] as a dependency.
113115
macros = ["dep:serde_with_macros"]
114116
## This feature enables integration with `schemars` 0.8.
115117
## This makes `#[derive(JsonSchema)]` pick up the correct schema for the type
116118
## used within `#[serde_as(as = ...)]`.
117119
##
118-
## This pulls in `schemars` v0.8 as a dependency. It will also implicitly enable
120+
## This pulls in [`schemars` v0.8](::schemars_0_8) as a dependency. It will also implicitly enable
119121
## the `std` feature as `schemars` is not `#[no_std]`.
120122
schemars_0_8 = ["dep:schemars_0_8", "std", "serde_with_macros?/schemars_0_8"]
121123
## This feature enables integration with `schemars` 0.9
122124
## This makes `#[derive(JsonSchema)]` pick up the correct schema for the type
123125
## used within `#[serde_as(as = ...)]`.
124126
##
125-
## This pulls in `schemars` v0.9 as a dependency. It will also implicitly enable
127+
## This pulls in [`schemars` v0.9](::schemars_0_9) as a dependency. It will also implicitly enable
126128
## the `alloc` feature.
127129
schemars_0_9 = ["dep:schemars_0_9", "alloc", "serde_with_macros?/schemars_0_9", "dep:serde_json"]
128130
## The feature enables integration of `time` v0.3 specific conversions.
129131
## This includes support for the timestamp and duration types.
130132
##
131-
## This pulls in `time` v0.3 as a dependency.
133+
## This pulls in [`time` v0.3](::time_0_3) as a dependency.
132134
## Some functionality is only available when `alloc` or `std` is enabled too.
133135
time_0_3 = ["dep:time_0_3"]
134136

0 commit comments

Comments
 (0)