From e89a5331d3881af96a45408412fc27c4af5af72c Mon Sep 17 00:00:00 2001 From: Manuel Cillero Date: Sun, 27 Jul 2025 13:51:49 +0200 Subject: [PATCH 1/2] =?UTF-8?q?=F0=9F=92=A1=20Simplifica=20documentaci?= =?UTF-8?q?=C3=B3n=20de=20m=C3=A9todos=20`alter=5F=E2=80=A6()`?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- helpers/pagetop-macros/src/lib.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/helpers/pagetop-macros/src/lib.rs b/helpers/pagetop-macros/src/lib.rs index d9533fe..301f483 100644 --- a/helpers/pagetop-macros/src/lib.rs +++ b/helpers/pagetop-macros/src/lib.rs @@ -175,7 +175,7 @@ pub fn builder_fn(_: TokenStream, item: TokenStream) -> TokenStream { // Genera el método alter_...() con el código del método with_...(). let fn_alter_doc = format!( - "Equivale a invocar el método `{}()` cuando se aplica el patrón builder.", + "Igual que [`{0}()`](Self::{0}), pero sin usar el patrón *builder*.", fn_with_name_str, ); let fn_alter = quote! { From f23c8d5c4cd465d475f8af2eb235f3635a7e5c0d Mon Sep 17 00:00:00 2001 From: Manuel Cillero Date: Sun, 27 Jul 2025 13:55:28 +0200 Subject: [PATCH 2/2] =?UTF-8?q?=F0=9F=92=A1=20Mejora=20los=20comentarios?= =?UTF-8?q?=20para=20normalizar?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- src/config.rs | 2 +- src/core.rs | 4 ++-- src/core/component/children.rs | 14 ++++++++------ src/html/assets/favicon.rs | 2 +- src/html/assets/javascript.rs | 2 +- src/html/assets/stylesheet.rs | 4 ++-- src/lib.rs | 4 ++-- src/locale.rs | 10 +++++----- src/response/redirect.rs | 4 ++-- tests/util.rs | 2 +- 10 files changed, 25 insertions(+), 23 deletions(-) diff --git a/src/config.rs b/src/config.rs index ed37d55..5dc05a1 100644 --- a/src/config.rs +++ b/src/config.rs @@ -169,7 +169,7 @@ pub static CONFIG_VALUES: LazyLock> = LazyLock::new( /// ```rust,ignore /// include_config!(SETTINGS: Settings => [ /// "ruta.clave" => valor, -/// // … +/// // ... /// ]); /// ``` /// diff --git a/src/core.rs b/src/core.rs index 2168c93..0c8aa21 100644 --- a/src/core.rs +++ b/src/core.rs @@ -55,10 +55,10 @@ impl TypeInfo { fn partial(type_name: &'static str, start: isize, end: Option) -> &'static str { let maxlen = type_name.len(); - // Localiza los límites de cada segmento a nivel 0 de `<…>`. + // Localiza los límites de cada segmento a nivel 0 de `<...>`. let mut segments = Vec::new(); let mut segment_start = 0; // Posición inicial del segmento actual. - let mut angle_brackets = 0; // Profundidad dentro de '<…>'. + let mut angle_brackets = 0; // Profundidad dentro de '<...>'. let mut previous_char = '\0'; // Se inicializa a carácter nulo, no hay aún carácter previo. for (idx, c) in type_name.char_indices() { diff --git a/src/core/component/children.rs b/src/core/component/children.rs index cba8c39..cc3a864 100644 --- a/src/core/component/children.rs +++ b/src/core/component/children.rs @@ -85,7 +85,7 @@ impl Typed { // ************************************************************************************************* -/// Operaciones con un componente [`Child`] en una lista [`Children`]. +/// Operaciones con un componente hijo [`Child`] en una lista [`Children`]. pub enum ChildOp { Add(Child), InsertAfterId(&'static str, Child), @@ -96,7 +96,7 @@ pub enum ChildOp { Reset, } -/// Operaciones con un componente tipado [`Typed`] en una lista [`Children`]. +/// Operaciones con un componente hijo tipado [`Typed`] en una lista [`Children`]. pub enum TypedOp { Add(Typed), InsertAfterId(&'static str, Typed), @@ -107,9 +107,9 @@ pub enum TypedOp { Reset, } -/// Lista ordenada de los componentes hijo ([`Child`]) asociados a un componente padre. +/// Lista ordenada de componentes hijo ([`Child`]) mantenida por un componente padre. /// -/// Esta colección permite añadir, modificar, renderizar y consultar componentes hijos en orden de +/// Esta lista permite añadir, modificar, renderizar y consultar componentes hijo en orden de /// inserción, soportando operaciones avanzadas como inserción relativa o reemplazo por /// identificador. #[derive(Clone, Default)] @@ -121,7 +121,7 @@ impl Children { Children::default() } - /// Crea una lista con un único hijo inicial. + /// Crea una lista con un componente hijo inicial. pub fn with(child: Child) -> Self { Children::default().with_child(ChildOp::Add(child)) } @@ -165,7 +165,9 @@ impl Children { } } - /// Añade un hijo al final de la lista. + /// Añade un componente hijo al final de la lista. + /// + /// Es un atajo para `children.alter_child(ChildOp::Add(child))`. #[inline] pub fn add(&mut self, child: Child) -> &mut Self { self.0.push(child); diff --git a/src/html/assets/favicon.rs b/src/html/assets/favicon.rs index 97a44e8..d02794e 100644 --- a/src/html/assets/favicon.rs +++ b/src/html/assets/favicon.rs @@ -3,7 +3,7 @@ use crate::AutoDefault; /// Un **Favicon** es un recurso gráfico que usa el navegador como icono asociado al sitio. /// -/// Es universalmente aceptado para mostrar el icono del sitio (`.ico`, `.png`, `.svg`, …) en +/// Es universalmente aceptado para mostrar el icono del sitio (`.ico`, `.png`, `.svg`, ...) en /// pestañas, marcadores o accesos directos. /// /// Este tipo permite construir de forma fluida las distintas variantes de un *favicon*, ya sea un diff --git a/src/html/assets/javascript.rs b/src/html/assets/javascript.rs index fb0a1b6..882b3af 100644 --- a/src/html/assets/javascript.rs +++ b/src/html/assets/javascript.rs @@ -97,7 +97,7 @@ impl JavaScript { /// Crea un **script embebido** directamente en el documento HTML. /// - /// Equivale a ``. El parámetro `name` se usa como identificador interno del + /// Equivale a ``. El parámetro `name` se usa como identificador interno del /// *script*. pub fn inline(name: impl Into, script: impl Into) -> Self { JavaScript { diff --git a/src/html/assets/stylesheet.rs b/src/html/assets/stylesheet.rs index 7f64d18..dca5d86 100644 --- a/src/html/assets/stylesheet.rs +++ b/src/html/assets/stylesheet.rs @@ -82,7 +82,7 @@ impl TargetMedia { pub struct StyleSheet { source : Source, // Fuente y modo de inclusión del CSS. version: String, // Versión del recurso para la caché del navegador. - media : TargetMedia, // Medio objetivo para los estilos (`print`, `screen`, …). + media : TargetMedia, // Medio objetivo para los estilos (`print`, `screen`, ...). weight : Weight, // Peso que determina el orden. } @@ -99,7 +99,7 @@ impl StyleSheet { /// Crea una hoja de estilos embebida directamente en el documento HTML. /// - /// Equivale a ``. El parámetro `name` se usa como identificador interno del + /// Equivale a ``. El parámetro `name` se usa como identificador interno del /// recurso. pub fn inline(name: impl Into, styles: impl Into) -> Self { StyleSheet { diff --git a/src/lib.rs b/src/lib.rs index e2d3975..63ca6a5 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -33,8 +33,8 @@ html_favicon_url = "https://git.cillero.es/manuelcillero/pagetop/raw/branch/main/static/favicon.ico" )] -// Alias para que las rutas absolutas `::pagetop::…` generadas por las macros funcionen en el propio -// *crate*, en *crates* externos y en *doctests*. +// Alias para que las rutas absolutas `::pagetop::...` generadas por las macros funcionen en el +// propio *crate*, en *crates* externos y en *doctests*. extern crate self as pagetop; use std::collections::HashMap; diff --git a/src/locale.rs b/src/locale.rs index 9af83f5..298b350 100644 --- a/src/locale.rs +++ b/src/locale.rs @@ -119,13 +119,13 @@ static LANGUAGES: LazyLock> = LazyLock ] }); -// Identificador del idioma de **respaldo** (predefinido a `en-US`). +// Identificador de idioma de **respaldo** (predefinido a `en-US`). // // Se usa cuando el valor del identificador de idioma en las traducciones no corresponde con ningún // idioma soportado por la aplicación. static FALLBACK_LANGID: LazyLock = LazyLock::new(|| langid!("en-US")); -// Identificador del idioma **por defecto** para la aplicación. +// Identificador de idioma **por defecto** para la aplicación. // // Se resuelve a partir de [`global::SETTINGS.app.language`](global::SETTINGS). Si el identificador // de idioma no es válido o no está disponible entonces resuelve como [`FALLBACK_LANGID`]. @@ -177,13 +177,13 @@ pub(crate) static DEFAULT_LANGID: LazyLock<&LanguageIdentifier> = /// ``` #[derive(Clone, Debug, Eq, PartialEq)] pub enum LangMatch { - /// Cuando el identificador del idioma es una cadena vacía. + /// Cuando el identificador de idioma es una cadena vacía. Unspecified, /// Si encuentra un [`LanguageIdentifier`] en la lista de idiomas soportados por `PageTop` que - /// coincide exactamente con el identificador del idioma (p.ej. "es-ES"), o con el identificador + /// coincide exactamente con el identificador de idioma (p.ej. "es-ES"), o con el identificador /// del idioma base (p.ej. "es"). Found(&'static LanguageIdentifier), - /// Si el identificador del idioma no está entre los soportados por `PageTop`. + /// Si el identificador de idioma no está entre los soportados por `PageTop`. Unsupported(String), } diff --git a/src/response/redirect.rs b/src/response/redirect.rs index bb3020d..a3bec0c 100644 --- a/src/response/redirect.rs +++ b/src/response/redirect.rs @@ -43,7 +43,7 @@ impl Redirect { /// Redirección **permanente**. Código de estado **308**. Mantiene método y cuerpo sin cambios. /// /// Indicada para reorganizaciones de un sitio o aplicación web en las que también existen - /// métodos distintos de GET (POST, PUT, …) que no deben degradarse a GET. + /// métodos distintos de GET (POST, PUT, ...) que no deben degradarse a GET. #[must_use] pub fn permanent(redirect_to_url: &str) -> HttpResponse { HttpResponse::PermanentRedirect() @@ -55,7 +55,7 @@ impl Redirect { /// mantiene tal cual. Otros métodos pueden degradarse a GET. /// /// Útil cuando un recurso está fuera de servicio de forma imprevista (mantenimiento breve, - /// sobrecarga, …). + /// sobrecarga, ...). #[must_use] pub fn found(redirect_to_url: &str) -> HttpResponse { HttpResponse::Found() diff --git a/tests/util.rs b/tests/util.rs index 2d52064..6e0896f 100644 --- a/tests/util.rs +++ b/tests/util.rs @@ -44,7 +44,7 @@ mod windows { async fn ok_absolute_dir() -> io::Result<()> { let _app = service::test::init_service(Application::new().test()).await; - // C:\Users\…\Temp\… + // C:\Users\...\Temp\... let td = TempDir::new()?; let root = td.path(); let sub = root.join("sub");