Update docs

udoprog · May 16, 2024 · 17a6e6f · 17a6e6f
1 parent cc12737
commit 17a6e6f
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -161,7 +161,7 @@ that one model can add fields that an older version of the model should be
 capable of ignoring.
 
 Partial upgrade stability can still be useful as is the case of the
-*musli-storage* format below, because reading from storage only requires
+[`musli::storage`] format below, because reading from storage only requires
 decoding to be upgrade stable. So if correctly managed with
 `#[musli(default)]` this will never result in any readers seeing unknown
 fields.
@@ -196,7 +196,7 @@ types.
 `self` determines if the format is self-descriptive. Allowing the structure
 of the data to be fully reconstructed from its serialized state. These
 formats do not require models to decode and can be converted to and from
-dynamic containers such as [`musli-value`] for introspection. Such formats
+dynamic containers such as [`musli::value`] for introspection. Such formats
 also allows for type-coercions to be performed, so that a signed number can
 be correctly read as an unsigned number if it fits in the destination type.
 
@@ -359,11 +359,11 @@ safety, extensive testing and fuzzing is performed using `miri`. See
 [`derives`]: <https://docs.rs/musli/latest/musli/help/derives/index.html>
 [`Encode`]: <https://docs.rs/musli/latest/musli/en/trait.Encode.html>
 [`Encoder`]: <https://docs.rs/musli/latest/musli/trait.Encoder.html>
-[`musli-value`]: <https://docs.rs/musli/latest/musli/value/index.html>
 [`musli::descriptive`]: <https://docs.rs/musli/latest/musli/descriptive/index.html>
 [`musli::json`]: <https://docs.rs/musli/latest/musli/json/index.html>
 [`musli::serde`]: <https://docs.rs/musli/latest/musli/serde/index.html>
 [`musli::storage`]: <https://docs.rs/musli/latest/musli/storage/index.html>
+[`musli::value`]: <https://docs.rs/musli/latest/musli/value/index.html>
 [`musli::wire`]: <https://docs.rs/musli/latest/musli/wire/index.html>
 [`protobuf`]: <https://developers.google.com/protocol-buffers>
 [`serde`]: <https://serde.rs>

diff --git a/crates/musli-zerocopy/README.md b/crates/musli-zerocopy/README.md
@@ -42,6 +42,8 @@ might be interested in:
   functions.
 * [`swiss`] is a port of the [`hashbrown` crate] which is a Google
   SwissTable implementation.
+* [`trie`] is an implementation of a prefix-trie, which supports efficient
+  multi-value byte-prefixed lookups.
 
 Finally if you're interested in the performance of `musli-zerocopy` you
 should go to [`benchmarks`]. I will be extending this suite with more
@@ -463,6 +465,7 @@ buf.store(&Custom { reference, slice, unsize });
 [`requested()`]: https://docs.rs/musli-zerocopy/latest/musli_zerocopy/struct.OwnedBuf.html#method.requested
 [`Size`]: https://docs.rs/musli-zerocopy/latest/musli_zerocopy/pointer/trait.Size.html
 [`swiss`]: https://docs.rs/musli-zerocopy/latest/musli_zerocopy/swiss/index.html
+[`trie`]: https://docs.rs/musli-zerocopy/latest/musli_zerocopy/trie/index.html
 [`with_byte_order::<E>()`]: https://docs.rs/musli-zerocopy/latest/musli_zerocopy/buf/struct.OwnedBuf.html#method.with_byte_order
 [`ZeroCopy`]: https://docs.rs/musli-zerocopy/latest/musli_zerocopy/trait.ZeroCopy.html
 [derive]: https://docs.rs/musli-zerocopy/latest/musli_zerocopy/derive.ZeroCopy.html

diff --git a/crates/musli/README.md b/crates/musli/README.md
@@ -161,7 +161,7 @@ that one model can add fields that an older version of the model should be
 capable of ignoring.
 
 Partial upgrade stability can still be useful as is the case of the
-*musli-storage* format below, because reading from storage only requires
+[`musli::storage`] format below, because reading from storage only requires
 decoding to be upgrade stable. So if correctly managed with
 `#[musli(default)]` this will never result in any readers seeing unknown
 fields.
@@ -196,7 +196,7 @@ types.
 `self` determines if the format is self-descriptive. Allowing the structure
 of the data to be fully reconstructed from its serialized state. These
 formats do not require models to decode and can be converted to and from
-dynamic containers such as [`musli-value`] for introspection. Such formats
+dynamic containers such as [`musli::value`] for introspection. Such formats
 also allows for type-coercions to be performed, so that a signed number can
 be correctly read as an unsigned number if it fits in the destination type.
 
@@ -359,11 +359,11 @@ safety, extensive testing and fuzzing is performed using `miri`. See
 [`derives`]: <https://docs.rs/musli/latest/musli/help/derives/index.html>
 [`Encode`]: <https://docs.rs/musli/latest/musli/en/trait.Encode.html>
 [`Encoder`]: <https://docs.rs/musli/latest/musli/trait.Encoder.html>
-[`musli-value`]: <https://docs.rs/musli/latest/musli/value/index.html>
 [`musli::descriptive`]: <https://docs.rs/musli/latest/musli/descriptive/index.html>
 [`musli::json`]: <https://docs.rs/musli/latest/musli/json/index.html>
 [`musli::serde`]: <https://docs.rs/musli/latest/musli/serde/index.html>
 [`musli::storage`]: <https://docs.rs/musli/latest/musli/storage/index.html>
+[`musli::value`]: <https://docs.rs/musli/latest/musli/value/index.html>
 [`musli::wire`]: <https://docs.rs/musli/latest/musli/wire/index.html>
 [`protobuf`]: <https://developers.google.com/protocol-buffers>
 [`serde`]: <https://serde.rs>

diff --git a/crates/musli/src/lib.rs b/crates/musli/src/lib.rs
@@ -163,7 +163,7 @@
 //! capable of ignoring.
 //!
 //! Partial upgrade stability can still be useful as is the case of the
-//! *musli-storage* format below, because reading from storage only requires
+//! [`musli::storage`] format below, because reading from storage only requires
 //! decoding to be upgrade stable. So if correctly managed with
 //! `#[musli(default)]` this will never result in any readers seeing unknown
 //! fields.
@@ -198,7 +198,7 @@
 //! `self` determines if the format is self-descriptive. Allowing the structure
 //! of the data to be fully reconstructed from its serialized state. These
 //! formats do not require models to decode and can be converted to and from
-//! dynamic containers such as [`musli-value`] for introspection. Such formats
+//! dynamic containers such as [`musli::value`] for introspection. Such formats
 //! also allows for type-coercions to be performed, so that a signed number can
 //! be correctly read as an unsigned number if it fits in the destination type.
 //!
@@ -370,11 +370,11 @@
 //! [`derives`]: <https://docs.rs/musli/latest/musli/help/derives/index.html>
 //! [`Encode`]: <https://docs.rs/musli/latest/musli/en/trait.Encode.html>
 //! [`Encoder`]: <https://docs.rs/musli/latest/musli/trait.Encoder.html>
-//! [`musli-value`]: <https://docs.rs/musli/latest/musli/value/index.html>
 //! [`musli::descriptive`]: <https://docs.rs/musli/latest/musli/descriptive/index.html>
 //! [`musli::json`]: <https://docs.rs/musli/latest/musli/json/index.html>
 //! [`musli::serde`]: <https://docs.rs/musli/latest/musli/serde/index.html>
 //! [`musli::storage`]: <https://docs.rs/musli/latest/musli/storage/index.html>
+//! [`musli::value`]: <https://docs.rs/musli/latest/musli/value/index.html>
 //! [`musli::wire`]: <https://docs.rs/musli/latest/musli/wire/index.html>
 //! [`protobuf`]: <https://developers.google.com/protocol-buffers>
 //! [`serde`]: <https://serde.rs>