🚧 Retoques menores en la documentación
This commit is contained in:
parent
d8ba5e1eff
commit
27ec613453
4 changed files with 12 additions and 8 deletions
|
|
@ -49,7 +49,7 @@ pub enum ContextError {
|
|||
///
|
||||
/// `Contextual` extiende [`LangId`] para establecer el idioma del documento y añade métodos para:
|
||||
///
|
||||
/// - Almacenar la **solicitud HTTP** de origen.
|
||||
/// - Almacenar la **petición HTTP** de origen.
|
||||
/// - Seleccionar el **tema** y la **plantilla** de renderizado.
|
||||
/// - Administrar **recursos** del documento como el icono [`Favicon`], las hojas de estilo
|
||||
/// [`StyleSheet`] o los scripts [`JavaScript`] mediante [`ContextOp`].
|
||||
|
|
@ -81,7 +81,7 @@ pub trait Contextual: LangId {
|
|||
#[builder_fn]
|
||||
fn with_langid(self, language: &impl LangId) -> Self;
|
||||
|
||||
/// Almacena la solicitud HTTP de origen en el contexto.
|
||||
/// Almacena la petición HTTP de origen en el contexto.
|
||||
#[builder_fn]
|
||||
fn with_request(self, request: Option<HttpRequest>) -> Self;
|
||||
|
||||
|
|
@ -107,7 +107,7 @@ pub trait Contextual: LangId {
|
|||
|
||||
// **< Contextual GETTERS >*********************************************************************
|
||||
|
||||
/// Devuelve una referencia a la solicitud HTTP asociada, si existe.
|
||||
/// Devuelve una referencia a la petición HTTP asociada, si existe.
|
||||
fn request(&self) -> Option<&HttpRequest>;
|
||||
|
||||
/// Devuelve el tema que se usará para renderizar el documento.
|
||||
|
|
@ -161,7 +161,7 @@ pub trait Contextual: LangId {
|
|||
///
|
||||
/// # Ejemplos
|
||||
///
|
||||
/// Crea un nuevo contexto asociado a una solicitud HTTP:
|
||||
/// Crea un nuevo contexto asociado a una petición HTTP:
|
||||
///
|
||||
/// ```rust
|
||||
/// # use pagetop::prelude::*;
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@ use crate::{builder_fn, AutoDefault};
|
|||
/// Some("¡Hola mundo!".to_string())
|
||||
/// );
|
||||
///
|
||||
/// // Japonés no disponible, traduce al idioma de respaldo ("en-US").
|
||||
/// // Japonés no disponible, traduce al idioma de respaldo (`"en-US"`).
|
||||
/// assert_eq!(
|
||||
/// hello.lookup(&LangMatch::resolve("ja-JP")),
|
||||
/// Some("Hello world!".to_string())
|
||||
|
|
|
|||
|
|
@ -101,7 +101,7 @@ pub struct Page {
|
|||
impl Page {
|
||||
/// Crea una nueva instancia de página.
|
||||
///
|
||||
/// La solicitud HTTP se guardará en el contexto de renderizado de la página para poder ser
|
||||
/// La petición HTTP se guardará en el contexto de renderizado de la página para poder ser
|
||||
/// recuperada por los componentes si es necesario.
|
||||
#[rustfmt::skip]
|
||||
pub fn new(request: HttpRequest) -> Self {
|
||||
|
|
@ -211,7 +211,7 @@ impl Page {
|
|||
/// Devuelve una referencia mutable al [`Context`] de la página.
|
||||
///
|
||||
/// El [`Context`] actúa como intermediario para muchos métodos de `Page` (idioma, tema,
|
||||
/// *layout*, recursos, solicitud HTTP, etc.). Resulta especialmente útil cuando un componente
|
||||
/// *layout*, recursos, petición HTTP, etc.). Resulta especialmente útil cuando un componente
|
||||
/// o un tema necesita recibir el contexto como parámetro.
|
||||
pub fn context(&mut self) -> &mut Context {
|
||||
&mut self.context
|
||||
|
|
@ -289,6 +289,10 @@ impl Page {
|
|||
}
|
||||
}
|
||||
|
||||
/// Permite a [`Page`] actuar como proveedor de idioma usando el [`Context`] de la página.
|
||||
///
|
||||
/// Resulta útil para usar [`Page`] directamente como fuente de traducción en [`L10n::lookup()`] o
|
||||
/// [`L10n::using()`].
|
||||
impl LangId for Page {
|
||||
fn langid(&self) -> &'static LanguageIdentifier {
|
||||
self.context.langid()
|
||||
|
|
|
|||
|
|
@ -18,7 +18,6 @@ pub use indoc::{concatdoc, formatdoc, indoc};
|
|||
|
||||
// **< MACROS ÚTILES >******************************************************************************
|
||||
|
||||
#[macro_export]
|
||||
/// Macro para construir una colección de pares clave-valor.
|
||||
///
|
||||
/// ```rust
|
||||
|
|
@ -31,6 +30,7 @@ pub use indoc::{concatdoc, formatdoc, indoc};
|
|||
/// "userGender" => "male",
|
||||
/// ];
|
||||
/// ```
|
||||
#[macro_export]
|
||||
macro_rules! hm {
|
||||
( $($key:expr => $value:expr),* $(,)? ) => {{
|
||||
let mut a = std::collections::HashMap::new();
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue