docs: enhance script name handling in logging documentation#117
Merged
Conversation
Copilot stopped reviewing on behalf of
GingerGraham due to an error
May 27, 2026 12:47
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request updates the documentation to clarify how the
%splaceholder in log formats works and provides guidance on customizing the script name for logging. It emphasizes that%sreflects the value set viaset_script_name, and offers examples for dynamically setting it to reflect runtime context such as function names or user names.Documentation improvements for
%sand script name handling:docs/formatting.mdthat%sin log formats reflects the script name set during initialization or viaset_script_name, and explained how to use it for custom runtime context by updating the script name in your code.docs/initialization.mdto instruct users to useset_script_nameduring runtime for dynamic log identifiers, with a pointer to the runtime configuration documentation.docs/runtime-configuration.mdfor setting%sto function names, user names, or other runtime-specific identifiers, and clarified that the logger does not infer these automatically.Documentation structure and navigation:
set_timezone_utcafterset_log_level.Fixes: #29 #30