Restore docs CI checks and fix all doc lints (#4204)
This commit is contained in:
1 parent
9027ffc278
commit
ee3b45af49
57 files changed
+120
-130
No files matched your search
@@ -53,5 +53,5 @@ The rust [nomicon](https://doc.rust-lang.org/nomicon/data.html) defines the memo
|
||||
## Limitations
|
||||
|
||||
- Only constant sized types are supported. This means that you can't serialize a type like `Vec<T>`. These types are difficult to create in const contexts in general
|
||||
- Only types with a well defined memory layout are supported (see https://github.com/rust-lang/rfcs/pull/3727 and https://onevariable.com/blog/pods-from-scratch). `repr(Rust)` enums don't have a well defined layout, so they are not supported. `repr(C, u8)` enums can be used instead
|
||||
- Only types with a well defined memory layout are supported (see <https://github.com/rust-lang/rfcs/pull/3727> and <https://onevariable.com/blog/pods-from-scratch>). `repr(Rust)` enums don't have a well defined layout, so they are not supported. `repr(C, u8)` enums can be used instead
|
||||
- Const rust does not support mutable references or points, so this crate leans heavily on function data structures for data processing.
|
||||
@@ -328,7 +328,7 @@ impl<T, const MAX_SIZE: usize> ConstVec<T, MAX_SIZE> {
|
||||
}
|
||||
|
||||
impl<const MAX_SIZE: usize> ConstVec<u8, MAX_SIZE> {
|
||||
/// Convert the [`ConstVec`] into a [`ConstReadBuffer`](crate::ConstReadBuffer)
|
||||
/// Convert the [`ConstVec`] into a [`ConstReadBuffer`]
|
||||
///
|
||||
/// # Example
|
||||
/// ```rust
|
||||
|
||||
@@ -857,7 +857,7 @@ const fn deserialize_const_ptr<'a, const N: usize>(
|
||||
}
|
||||
}
|
||||
|
||||
/// Deserialize a type into the output buffer. Accepts (Type, ConstVec<u8>) as input and returns Option<(ConstReadBuffer, Instance of type)>
|
||||
/// Deserialize a type into the output buffer. Accepts `(type, ConstVec<u8>)` as input and returns `Option<(ConstReadBuffer, Instance of type)>`
|
||||
///
|
||||
/// # Example
|
||||
/// ```rust
|
||||
|
||||
Reference in new issue
Block a user