Repository navigation
docs: explain timestamp and asctime formatting - #85
Open
arindamsikder wants to merge 1 commit into
Open
arindamsikder wants to merge 1 commit into
arindamsikder wants to merge 1 commit into
Conversation
This branch has not been deployed
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.
Summary
Add a dedicated Logging Time guide and link it from the documentation navigation.
Problem
In #17, readers were unsure whether
timestampwas supported, whether it emitted an epoch number or ISO 8601 string, and how it differed fromasctime. The discussion explicitly welcomes a separate page documenting the current behavior.Solution
timestampvalues, custom field names, and why puttingtimestampinfmtalone producesnull.asctime,datefmt, UTC conversion, fractional seconds, and field-name collisions without changing their behavior.dictConfigexample, including the boolean-versus-string configuration distinction.This is documentation only: no runtime, dependency, version, or time-format contract changes.
Testing
Validation ran on Python 3.11 in a credential-free, network-isolated Bubblewrap environment:
python -m pytest tests -q -p no:cacheprovider --basetemp=/tmp/pytest— 221 passed on both the unchanged base and the final tree.dictConfigoutput fields and an aware UTC timestamp within the actual execution window.datefmt/converterindependence and string-key behavior with the stdlib JSON, orjson and msgspec formatters.python -m black --check --diff src tests— passed (14 files unchanged; Black emitted a Python-target-version warning).python -m pylint src— passed, 10.00/10.python -m mypy src tests --cache-dir /tmp/mypy-cache— passed, 14 source files.python -m mkdocs build --site-dir /out/final-site— completed; rendered the new page and verified its navigation link. The seven pre-existing annotation warnings and unavailable external Python inventory diagnostic were identical on the unchanged base. The inventory cannot be downloaded in the offline sandbox.git diff --checkand independent automated diff review — passed.The current unpinned Python docs handler 2.0 rejected the existing
importconfiguration. For both baseline and final documentation builds, I used mkdocstrings 0.30.1, mkdocstrings-python 1.18.2, and mkdocs-gen-files 0.5.0. No dependency pins were added to this PR. Other Python versions and operating systems were not run locally.Related Issue
Related to #17 — addresses the requested documentation, not the broader possible behavior changes discussed there.
AI assistance
Prepared by Hermes DEV using OpenAI GPT-6 Astra, including the documentation, local validation and an independent automated diff review. No human review is claimed.