diff --git a/docs/api/build-application-text-async-logger.md b/docs/api/build-application-text-async-logger.md index 5185eab..3cd9800 100644 --- a/docs/api/build-application-text-async-logger.md +++ b/docs/api/build-application-text-async-logger.md @@ -38,6 +38,8 @@ Detailed rules explaining key parameters and behaviors - This API delegates to `build_async_text_logger(...)`. - It is intended for config-driven async text console output where callers want the concrete text sink shape rather than the broader runtime sink enum wrapper. - The builder always creates a `FormattedConsoleSink` from `config.logger.sink.text_formatter` instead of selecting among sink kinds. +- Unlike `build_application_async_logger(...)`, this facade does not go through the full synchronous configured-logger build path first. +- It uses the selected text-oriented `LoggerConfig` fields directly and therefore does not apply `LoggerConfig.queue` or preserve sync runtime sink controls. - The returned logger keeps the usual async lifecycle helpers. ### How to Use diff --git a/docs/api/build-async-text-logger.md b/docs/api/build-async-text-logger.md index 35186dd..9e7132e 100644 --- a/docs/api/build-async-text-logger.md +++ b/docs/api/build-async-text-logger.md @@ -3,7 +3,7 @@ name: build-async-text-logger group: api category: async update-time: 20260614 -description: Build an async logger with a concrete text-console sink from combined logger and async config, always using the configured text formatter. +description: Build an async logger with a concrete text-console sink from combined logger and async config, using only the selected text-oriented LoggerConfig fields instead of the full sync build path. key-word: - async - text @@ -36,6 +36,8 @@ Detailed rules explaining key parameters and behaviors - This builder converts `config.logger.sink.text_formatter` into a runtime `TextFormatter` and wires it into `text_console_sink(...)`. - It always constructs a `FormattedConsoleSink` directly instead of branching on `config.logger.sink.kind`. - The returned logger inherits `min_level`, `target`, and timestamp behavior from `config.logger`. +- Unlike `build_async_logger(...)`, this helper does not run the full synchronous `build_logger(config.logger)` path first. +- That means it uses `config.logger.sink.text_formatter`, `min_level`, `target`, and `timestamp` directly, but it does not apply `LoggerConfig.queue` or preserve other sync runtime sink controls. - This helper is best suited to text-console output paths where callers want the concrete formatted sink type instead of `RuntimeSink`. - This async text path follows the same target story as the broader async library: `native / js / wasm / wasm-gc` have stronger local verification, while `llvm` remains experimental and locally unverified in this environment. diff --git a/docs/api/build-library-async-text-logger.md b/docs/api/build-library-async-text-logger.md index b7a17af..11c52a3 100644 --- a/docs/api/build-library-async-text-logger.md +++ b/docs/api/build-library-async-text-logger.md @@ -37,6 +37,8 @@ Detailed rules explaining key parameters and behaviors - This API delegates to `build_async_text_logger(...)` and then wraps the result as `LibraryAsyncLogger`. - It always produces a concrete `FormattedConsoleSink` from `config.logger.sink.text_formatter` instead of selecting among sink kinds. +- Unlike `build_library_async_logger(...)`, this facade does not go through the full synchronous configured-logger build path first. +- It uses the selected text-oriented `LoggerConfig` fields directly and therefore does not apply `LoggerConfig.queue` or preserve sync runtime sink controls. - It is useful when library code wants a narrow async facade while preserving a concrete text-console sink type. - `to_async_logger()` can recover the underlying full async logger if needed.