From 1e568f55cd2206e427cebaa301ec6f2c36b558d7 Mon Sep 17 00:00:00 2001 From: Nanaloveyuki Date: Sat, 13 Jun 2026 23:53:41 +0800 Subject: [PATCH] :memo: refine configured file setters docs --- docs/api/configured-logger-file-clear-rotation.md | 4 ++-- docs/api/configured-logger-file-rotation-config.md | 4 ++-- docs/api/configured-logger-file-rotation-enabled.md | 4 ++-- docs/api/configured-logger-file-set-append-mode.md | 4 ++-- docs/api/configured-logger-file-set-auto-flush.md | 4 ++-- docs/api/configured-logger-file-set-rotation.md | 4 ++-- 6 files changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/api/configured-logger-file-clear-rotation.md b/docs/api/configured-logger-file-clear-rotation.md index 5f3a75f..ed0238a 100644 --- a/docs/api/configured-logger-file-clear-rotation.md +++ b/docs/api/configured-logger-file-clear-rotation.md @@ -33,8 +33,8 @@ pub fn ConfiguredLogger::file_clear_rotation(self : ConfiguredLogger) -> Bool {} Detailed rules explaining key parameters and behaviors -- File-backed sinks clear their runtime rotation policy. -- Queued file sinks forward the update to the wrapped file sink. +- File-backed sinks clear their runtime rotation policy through the wrapped `RuntimeSink`. +- Queued file sinks forward the update to the wrapped inner file sink. - Non-file sinks return `false`. - This helper is equivalent in intent to setting rotation to `None`, but is clearer at the call site. diff --git a/docs/api/configured-logger-file-rotation-config.md b/docs/api/configured-logger-file-rotation-config.md index 1017661..61833c4 100644 --- a/docs/api/configured-logger-file-rotation-config.md +++ b/docs/api/configured-logger-file-rotation-config.md @@ -33,8 +33,8 @@ pub fn ConfiguredLogger::file_rotation_config(self : ConfiguredLogger) -> FileRo Detailed rules explaining key parameters and behaviors -- File-backed sinks return their current rotation configuration when enabled. -- Queued file sinks forward the config from the wrapped file sink. +- File-backed sinks return their current rotation configuration when enabled through the wrapped `RuntimeSink`. +- Queued file sinks forward the config from the wrapped inner file sink. - Non-file sinks return `None`. - This helper is useful when callers need active runtime rotation parameters rather than only a boolean flag. diff --git a/docs/api/configured-logger-file-rotation-enabled.md b/docs/api/configured-logger-file-rotation-enabled.md index 238c999..04ea495 100644 --- a/docs/api/configured-logger-file-rotation-enabled.md +++ b/docs/api/configured-logger-file-rotation-enabled.md @@ -33,8 +33,8 @@ pub fn ConfiguredLogger::file_rotation_enabled(self : ConfiguredLogger) -> Bool Detailed rules explaining key parameters and behaviors -- File-backed sinks report whether a rotation config is active. -- Queued file sinks forward the state from the wrapped file sink. +- File-backed sinks report whether a rotation config is active through the wrapped `RuntimeSink`. +- Queued file sinks forward the state from the wrapped inner file sink. - Non-file sinks return `false`. - This helper is narrower than `file_rotation_config()` when only a yes/no check is needed. diff --git a/docs/api/configured-logger-file-set-append-mode.md b/docs/api/configured-logger-file-set-append-mode.md index f4c4ef7..0d51a00 100644 --- a/docs/api/configured-logger-file-set-append-mode.md +++ b/docs/api/configured-logger-file-set-append-mode.md @@ -34,8 +34,8 @@ pub fn ConfiguredLogger::file_set_append_mode(self : ConfiguredLogger, append : Detailed rules explaining key parameters and behaviors -- File-backed sinks update their stored append policy. -- Queued file sinks forward the policy update to the wrapped file sink. +- File-backed sinks update their stored append policy through the wrapped `RuntimeSink`. +- Queued file sinks forward the policy update to the wrapped inner file sink. - This helper updates policy only; it does not force immediate reopen. - Non-file sinks return `false`. diff --git a/docs/api/configured-logger-file-set-auto-flush.md b/docs/api/configured-logger-file-set-auto-flush.md index 34f3161..2fb6ea6 100644 --- a/docs/api/configured-logger-file-set-auto-flush.md +++ b/docs/api/configured-logger-file-set-auto-flush.md @@ -34,8 +34,8 @@ pub fn ConfiguredLogger::file_set_auto_flush(self : ConfiguredLogger, enabled : Detailed rules explaining key parameters and behaviors -- File-backed sinks update their runtime auto-flush policy. -- Queued file sinks forward the update to the wrapped file sink. +- File-backed sinks update their runtime auto-flush policy through the wrapped `RuntimeSink`. +- Queued file sinks forward the update to the wrapped inner file sink. - Non-file sinks return `false`. - This helper changes policy only; it does not itself flush pending data. diff --git a/docs/api/configured-logger-file-set-rotation.md b/docs/api/configured-logger-file-set-rotation.md index 7c003f0..51aace7 100644 --- a/docs/api/configured-logger-file-set-rotation.md +++ b/docs/api/configured-logger-file-set-rotation.md @@ -37,8 +37,8 @@ pub fn ConfiguredLogger::file_set_rotation( Detailed rules explaining key parameters and behaviors -- File-backed sinks update their runtime rotation policy. -- Queued file sinks forward the update to the wrapped file sink. +- File-backed sinks update their runtime rotation policy through the wrapped `RuntimeSink`. +- Queued file sinks forward the update to the wrapped inner file sink. - Passing `None` disables rotation. - Non-file sinks return `false`.