Repository navigation
Document logging lifecycle and actual exception coverage - #7
Merged
Merged
Conversation
ctoth
force-pushed
the
improve/syslog-utc
branch
from
October 29, 2026 18:31
9e63ab2 to
2971bf1
Compare
ctoth
force-pushed
the
improve/logging-documentation
branch
from
October 29, 2026 18:32
0613fc0 to
b6de166
Compare
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.
Goal
Document the package's real application use and exception coverage.
State
Documentation-only PR independently based on integrated master. Explain the existing API, thresholds, write mode, fatal dumps, descriptor lifetime, process-wide shutdown, and framework-owned paths and retention. No open PR's commits are inherited.
Decisions and why
Document behavior established by master, rather than promising behavior that exists only in other open PRs. Omit the old stack's claims about UTF-8, transactional construction, repeat replacement and corrected exit cleanup; those are independent proposed fixes. Keep the usage and coverage documentation useful without requiring those PRs.
Surprises
Explicit shutdown is not exported at package level and calls global logging.shutdown. sys.excepthook, executor/wx error handling and fatal dumps cover different paths.
Next step
Read this PR's existing package/README metadata checks. No merge or release.