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
@@ -263,7 +263,7 @@ pub trait Readable {
|
||||
}
|
||||
}
|
||||
|
||||
/// An extension trait for Readable<Vec<T>> that provides some convenience methods.
|
||||
/// An extension trait for `Readable<Vec<T>>` that provides some convenience methods.
|
||||
pub trait ReadableVecExt<T: 'static>: Readable<Target = Vec<T>> {
|
||||
/// Returns the length of the inner vector.
|
||||
#[track_caller]
|
||||
@@ -331,7 +331,7 @@ where
|
||||
{
|
||||
}
|
||||
|
||||
/// An extension trait for Readable<Option<T>> that provides some convenience methods.
|
||||
/// An extension trait for `Readable<Option<T>>` that provides some convenience methods.
|
||||
pub trait ReadableOptionExt<T: 'static>: Readable<Target = Option<T>> {
|
||||
/// Unwraps the inner value and clones it.
|
||||
#[track_caller]
|
||||
@@ -356,7 +356,7 @@ where
|
||||
{
|
||||
}
|
||||
|
||||
/// An extension trait for Readable<Option<T>> that provides some convenience methods.
|
||||
/// An extension trait for `Readable<Option<T>>` that provides some convenience methods.
|
||||
pub trait ReadableResultExt<T: 'static, E: 'static>: Readable<Target = Result<T, E>> {
|
||||
/// Unwraps the inner value and clones it.
|
||||
#[track_caller]
|
||||
|
||||
@@ -18,7 +18,7 @@ pub struct SetCompare<R: 'static, S: Storage<SignalData<bool>> = UnsyncStorage>
|
||||
impl<R: Eq + Hash> SetCompare<R> {
|
||||
/// Creates a new [`SetCompare`] which efficiently tracks when a value changes to check if it is equal to a set of values.
|
||||
///
|
||||
/// Generally, you shouldn't need to use this hook. Instead you can use [`crate::use_memo`]. If you have many values that you need to compare to a single value, this hook will change updates from O(n) to O(1) where n is the number of values you are comparing to.
|
||||
/// Generally, you shouldn't need to use this hook. Instead you can use [`crate::Memo`]. If you have many values that you need to compare to a single value, this hook will change updates from O(n) to O(1) where n is the number of values you are comparing to.
|
||||
#[track_caller]
|
||||
pub fn new(f: impl FnMut() -> R + 'static) -> SetCompare<R> {
|
||||
Self::new_maybe_sync(f)
|
||||
@@ -28,7 +28,7 @@ impl<R: Eq + Hash> SetCompare<R> {
|
||||
impl<R: Eq + Hash, S: Storage<SignalData<bool>>> SetCompare<R, S> {
|
||||
/// Creates a new [`SetCompare`] that may be `Sync + Send` which efficiently tracks when a value changes to check if it is equal to a set of values.
|
||||
///
|
||||
/// Generally, you shouldn't need to use this hook. Instead you can use [`crate::use_memo`]. If you have many values that you need to compare to a single value, this hook will change updates from O(n) to O(1) where n is the number of values you are comparing to.
|
||||
/// Generally, you shouldn't need to use this hook. Instead you can use [`crate::Memo`]. If you have many values that you need to compare to a single value, this hook will change updates from O(n) to O(1) where n is the number of values you are comparing to.
|
||||
#[track_caller]
|
||||
pub fn new_maybe_sync(mut f: impl FnMut() -> R + 'static) -> SetCompare<R> {
|
||||
let subscribers: CopyValue<FxHashMap<R, Signal<bool>>> =
|
||||
|
||||
Reference in new issue
Block a user