Skip to content

Commit

Permalink
fix(docs): fixed broken docs links
Browse files Browse the repository at this point in the history
  • Loading branch information
arctic-hen7 committed Jan 7, 2023
1 parent f2aa96e commit ee56bc4
Show file tree
Hide file tree
Showing 11 changed files with 16 additions and 16 deletions.
2 changes: 1 addition & 1 deletion packages/perseus/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ pub mod server;
/// Utilities for working with Perseus' state platform.
pub mod state;
/// Utilities for working with immutable and mutable stores. See
/// [`ImmutableStore`] and [`MutableStore`] for details.
/// [`stores::ImmutableStore`] and [`stores::MutableStore`] for details.
pub mod stores;
/// Utilities for working with templates and state generation. This is by far
/// the module you'll probably access the most.
Expand Down
2 changes: 1 addition & 1 deletion packages/perseus/src/reactor/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ pub struct Reactor<G: Html> {
#[cfg(engine)]
pub(crate) render_mode: RenderMode<G>,
/// The currently active translator. On the browser-side, this is handled by
/// the more fully-fledged [`ClientTranslationsManager`].
/// the more fully-fledged `ClientTranslationsManager` type.
///
/// This is provided to the engine-side reactor on instantiation. This can
/// be `None` in certain error view renders.
Expand Down
2 changes: 1 addition & 1 deletion packages/perseus/src/state/rx_collections/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
//! Finally, every file in this module follows the same code pattern, allowing
//! maximal extensibility and self-documentation:
//!
//! ```
//! ```text
//! // --- Type definitions ---
//! // ...
//! // --- Reactivity implementations ---
Expand Down
2 changes: 1 addition & 1 deletion packages/perseus/src/state/rx_collections/rx_hash_map.rs
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ use sycamore::reactive::{create_rc_signal, RcSignal};
/// This requires nothing by `Clone + 'static` of the elements inside the map,
/// and it wraps them in `RcSignal`s to make them reactive. If you want to store
/// nested reactive types inside the map (e.g. `String`s), you should
/// use [`RxVecNested`].
/// use [`super::RxHashMapNested`].
#[derive(Serialize, Deserialize, Clone, Debug)]
pub struct RxHashMap<K, V>(HashMap<K, V>)
where
Expand Down
12 changes: 6 additions & 6 deletions packages/perseus/src/state/rx_collections/rx_hash_map_nested.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ use std::ops::Deref;
#[cfg(client)]
use sycamore::prelude::Scope;

/// A reactive version of [`Vec`] that uses nested reactivity on its elements.
/// That means the type inside the vector must implement [`MakeRx`] (usually
/// derived with the `ReactiveState` macro). If you want to store simple types
/// inside the vector, without nested reactivity (e.g. `String`s), you should
/// use [`RxVec`].
/// A reactive version of [`HashMap`] that uses nested reactivity on its
/// elements. That means the type inside the vector must implement [`MakeRx`]
/// (usually derived with the `ReactiveState` macro). If you want to store
/// simple types inside the vector, without nested reactivity (e.g. `String`s),
/// you should use [`super::RxHashMap`].
#[derive(Serialize, Deserialize, Clone, Debug)]
pub struct RxHashMapNested<K, V>(HashMap<K, V>)
where
Expand All @@ -19,7 +19,7 @@ where
// including the actual bounds here
V: MakeRx + 'static,
V::Rx: MakeUnrx<Unrx = V> + Freeze + Clone;
/// The reactive version of [`RxHashMap`].
/// The reactive version of [`RxHashMapNested`].
#[derive(Clone, Debug)]
pub struct RxHashMapNestedRx<K, V>(HashMap<K, V::Rx>)
where
Expand Down
2 changes: 1 addition & 1 deletion packages/perseus/src/state/rx_collections/rx_vec.rs
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ use sycamore::reactive::{create_rc_signal, RcSignal};
/// This requires nothing by `Clone + 'static` of the elements inside the
/// vector, and it wraps them in `RcSignal`s to make them reactive. If you want
/// to store nested reactive types inside the vector (e.g. `String`s), you
/// should use [`RxVecNested`].
/// should use [`super::RxVecNested`].
#[derive(Serialize, Deserialize, Clone, Debug)]
pub struct RxVec<T>(Vec<T>)
where
Expand Down
2 changes: 1 addition & 1 deletion packages/perseus/src/state/rx_collections/rx_vec_nested.rs
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ use sycamore::prelude::Scope;
/// That means the type inside the vector must implement [`MakeRx`] (usually
/// derived with the `ReactiveState` macro). If you want to store simple types
/// inside the vector, without nested reactivity (e.g. `String`s), you should
/// use [`RxVec`].
/// use [`super::RxVec`].
#[derive(Serialize, Deserialize, Clone, Debug)]
pub struct RxVecNested<T>(Vec<T>)
where
Expand Down
2 changes: 1 addition & 1 deletion packages/perseus/src/template/core/setters.rs
Original file line number Diff line number Diff line change
Expand Up @@ -261,7 +261,7 @@ impl<G: Html> TemplateInner<G> {
/// and request time. The function you provide here is responsible for
/// rationalizing the two into one single state to be sent to the client,
/// and this will be run just after the request state function
/// completes. See [`States`] for further details.
/// completes.
#[cfg(engine)]
pub fn amalgamate_states_fn<S, B, V>(
mut self,
Expand Down
2 changes: 1 addition & 1 deletion packages/perseus/src/template/fn_types.rs
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ impl<T> GeneratorResult<T> {
}
}
}
/// The same as [`GeneratorResult`], except this uses a [`GenericBlamedError`]
/// The same as [`GeneratorResult`], except this uses a `GenericBlamedError`
/// as its error type, which is essentially a `Box`ed generic error with an
/// attached [`ErrorBlame`] denoting who is responsible for the error: the
/// client or the server. You'll see this as a convertion type in the signatures
Expand Down
2 changes: 1 addition & 1 deletion packages/perseus/src/template/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ pub use fn_types::*; /* There are a lot of render function traits in here, there
pub(crate) use default_headers::default_headers;
// pub use render_ctx::RenderCtx;
// pub(crate) use render_ctx::{RenderMode, RenderStatus};
pub use capsule::Capsule;
pub use capsule::{Capsule, CapsuleInner};
#[cfg(engine)]
pub(crate) use states::States;

Expand Down
2 changes: 1 addition & 1 deletion packages/perseus/src/translator/fluent.rs
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ pub const FLUENT_TRANSLATOR_FILE_EXT: &str = "ftl";
/// Manages translations on the client-side for a single locale using Mozilla's [Fluent](https://projectfluent.org/) syntax.
/// This is safely `Clone`able, and is provided through Sycamore's context
/// system to every template in your app automatically. Usually, you will
/// use this only through the [`t!`] and [`link!`] macros.
/// use this only through the [`crate::t!`] and [`crate::link!`] macros.
///
/// Fluent supports compound messages, with many variants, which can specified
/// here using the form `[id].[variant]` in a translation ID, as a `.` is not
Expand Down

0 comments on commit ee56bc4

Please sign in to comment.