📝 [config] Mejora redacción de algunos textos
This commit is contained in:
parent
bb6cb07603
commit
9c29240c34
2 changed files with 14 additions and 12 deletions
|
|
@ -96,7 +96,8 @@ pub struct Server {
|
||||||
pub bind_port: u16,
|
pub bind_port: u16,
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Declara e inicializa los ajustes globales para la estructura [`Settings`].
|
/// Declara y asigna los valores predefinidos de los ajustes globales para la estructura
|
||||||
|
/// [`Settings`].
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// use pagetop::prelude::*;
|
/// use pagetop::prelude::*;
|
||||||
|
|
|
||||||
|
|
@ -41,7 +41,7 @@
|
||||||
//!
|
//!
|
||||||
//! # Cómo añadir ajustes de configuración
|
//! # Cómo añadir ajustes de configuración
|
||||||
//!
|
//!
|
||||||
//! Para proporcionar a tu **aplicación** o **módulo** sus propios ajustes de configuración, añade
|
//! Para proporcionar a tu **módulo** sus propios ajustes de configuración, añade
|
||||||
//! [*serde*](https://docs.rs/serde) en las dependencias de tu archivo *Cargo.toml* habilitando la
|
//! [*serde*](https://docs.rs/serde) en las dependencias de tu archivo *Cargo.toml* habilitando la
|
||||||
//! característica `derive`:
|
//! característica `derive`:
|
||||||
//!
|
//!
|
||||||
|
|
@ -50,9 +50,9 @@
|
||||||
//! serde = { version = "1.0", features = ["derive"] }
|
//! serde = { version = "1.0", features = ["derive"] }
|
||||||
//! ```
|
//! ```
|
||||||
//!
|
//!
|
||||||
//! Y luego declara ([`LazyStatic`]) e inicializa tus ajustes con tipos seguros
|
//! Y luego declara con [`LazyStatic`] tus ajustes, usando tipos seguros mediante
|
||||||
//! ([`config::try_into<S>()`](try_into)) y valores predefinidos
|
//! [`config::try_into<S>()`](try_into) y asignando los valores predefinidos directamente con la
|
||||||
//! ([`predefined_settings!`](crate::predefined_settings)):
|
//! macro [`predefined_settings!`](crate::predefined_settings) para la estructura asociada:
|
||||||
//!
|
//!
|
||||||
//! ```
|
//! ```
|
||||||
//! use pagetop::prelude::*;
|
//! use pagetop::prelude::*;
|
||||||
|
|
@ -81,12 +81,12 @@
|
||||||
//! });
|
//! });
|
||||||
//! ```
|
//! ```
|
||||||
//!
|
//!
|
||||||
//! De hecho, esta es la forma en la que se declaran e inicializan los ajustes globales de la
|
//! De hecho, así se declaran los ajustes globales de la configuración (ver
|
||||||
//! configuración ([`SETTINGS`](crate::app::config::SETTINGS)).
|
//! [`SETTINGS`](crate::app::config::SETTINGS)).
|
||||||
//!
|
//!
|
||||||
//! Usa la sintaxis TOML para añadir tu nueva sección `[myapp]` en los archivos de configuración,
|
//! Puedes usar la [sintaxis TOML](https://toml.io/en/v1.0.0#table) para añadir tu nueva sección
|
||||||
//! del mismo modo que se añaden `[log]` o `[server]` en los ajustes globales
|
//! `[myapp]` en los archivos de configuración, del mismo modo que se añaden `[log]` o `[server]` en
|
||||||
//! ([`Settings`](crate::app::config::Settings)).
|
//! los ajustes globales (ver [`Settings`](crate::app::config::Settings)).
|
||||||
//!
|
//!
|
||||||
//! Se recomienda inicializar todos los ajustes con valores predefinidos, o utilizar la notación
|
//! Se recomienda inicializar todos los ajustes con valores predefinidos, o utilizar la notación
|
||||||
//! `Option<T>` si van a ser tratados en el código como opcionales.
|
//! `Option<T>` si van a ser tratados en el código como opcionales.
|
||||||
|
|
@ -94,7 +94,7 @@
|
||||||
//! Si no pueden inicializarse correctamente los ajustes de configuración, entonces la aplicación
|
//! Si no pueden inicializarse correctamente los ajustes de configuración, entonces la aplicación
|
||||||
//! ejecutará un panic! y detendrá la ejecución.
|
//! ejecutará un panic! y detendrá la ejecución.
|
||||||
//!
|
//!
|
||||||
//! Los ajustes de configuración siempre son de sólo lectura.
|
//! Los ajustes de configuración siempre serán de sólo lectura.
|
||||||
//!
|
//!
|
||||||
//!
|
//!
|
||||||
//! # Cómo usar tus nuevos ajustes de configuración
|
//! # Cómo usar tus nuevos ajustes de configuración
|
||||||
|
|
@ -176,7 +176,8 @@ static CONFIG_DATA: LazyStatic<ConfigData> = LazyStatic::new(|| {
|
||||||
settings
|
settings
|
||||||
});
|
});
|
||||||
|
|
||||||
/// Carga ajustes con tipos seguros y valores predefinidos para tu aplicación o módulo.
|
/// Asigna los ajustes de configuración de tu módulo usando tipos seguros y valores predefinidos
|
||||||
|
/// para la estructura asociada S.
|
||||||
///
|
///
|
||||||
/// Detiene la aplicación con un panic! si no pueden asignarse los ajustes de configuración.
|
/// Detiene la aplicación con un panic! si no pueden asignarse los ajustes de configuración.
|
||||||
///
|
///
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue