Docs: Clarify strftime Python compatibility #387
Merged
Conversation
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
The docstring for the Python binding of `Epoch.strftime` previously claimed equivalence with Python's `datetime.strftime`. This is not entirely accurate, as `hifitime` supports a subset of C89-style format codes along with some hifitime-specific ones, but does not implement all of Python's directives (e.g., %W, %U, %G, %V, locale-specific formats). This commit updates the docstrings in `src/epoch/python.rs` and `hifitime.pyi` to more accurately describe the supported formatting capabilities and directs you to the hifitime documentation for the list of available format codes. Addresses issue #384.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
The docstring for the Python binding of
Epoch.strftimepreviously claimed equivalence with Python'sdatetime.strftime. This is not entirely accurate, ashifitimesupports a subset of C89-style format codes along with some hifitime-specific ones, but does not implement all of Python's directives (e.g., %W, %U, %G, %V, locale-specific formats).This commit updates the docstrings in
src/epoch/python.rsandhifitime.pyito more accurately describe the supported formatting capabilities and directs you to the hifitime documentation for the list of available format codes.Fixes #384.