Skip to content

docs: enhance script name handling in logging documentation#117

Merged
GingerGraham merged 1 commit into
mainfrom
docs/29-30-script-name-override
May 27, 2026
Merged

docs: enhance script name handling in logging documentation#117
GingerGraham merged 1 commit into
mainfrom
docs/29-30-script-name-override

Conversation

@GingerGraham
Copy link
Copy Markdown
Owner

@GingerGraham GingerGraham commented May 27, 2026

This pull request updates the documentation to clarify how the %s placeholder in log formats works and provides guidance on customizing the script name for logging. It emphasizes that %s reflects the value set via set_script_name, and offers examples for dynamically setting it to reflect runtime context such as function names or user names.

Documentation improvements for %s and script name handling:

  • Clarified in docs/formatting.md that %s in log formats reflects the script name set during initialization or via set_script_name, and explained how to use it for custom runtime context by updating the script name in your code.
  • Updated docs/initialization.md to instruct users to use set_script_name during runtime for dynamic log identifiers, with a pointer to the runtime configuration documentation.
  • Added detailed shell code examples and guidance in docs/runtime-configuration.md for setting %s to function names, user names, or other runtime-specific identifiers, and clarified that the logger does not infer these automatically.

Documentation structure and navigation:

  • Fixed the order of functions in the runtime configuration documentation's table of contents to correctly list set_timezone_utc after set_log_level.

Fixes: #29 #30

Copilot AI review requested due to automatic review settings May 27, 2026 12:42
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

@GingerGraham GingerGraham merged commit e326b50 into main May 27, 2026
5 of 7 checks passed
@GingerGraham GingerGraham deleted the docs/29-30-script-name-override branch May 27, 2026 13:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[FEATURE] Support user name as a logging parameter

2 participants