gh-97517: Add documentation links to datetime strftime/strptime docstrings#138559
gh-97517: Add documentation links to datetime strftime/strptime docstrings#138559pganssle merged 9 commits intopython:mainfrom
Conversation
- Add links to format codes documentation for all strftime methods - Add links to format codes documentation for all strptime methods - Addresses issue python#97517
|
All commit authors signed the Contributor License Agreement. |
This comment was marked as resolved.
This comment was marked as resolved.
StanFromIreland
changed the title
StanFromIreland
changed the title
StanFromIreland
left a comment
StanFromIreland
left a comment
There was a problem hiding this comment.
Please sign the CLA and update the C docstrings.
|
Got it, working on the CLA now and will update the C docstrings. Thanks! |
|
You need to run |
|
Please do not use the Update Branch button unless necessary (e.g. fixing conflicts, jogging the CI, or very old PRs) as it uses valuable resources. For more information see the devguide. To resolve the CI failure, see my above comment. |
StanFromIreland
left a comment
StanFromIreland
left a comment
There was a problem hiding this comment.
Please have consistent spacing, some docstrings have a line, some don't.
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
pganssle
left a comment
pganssle
left a comment
There was a problem hiding this comment.
Not too many places in the standard library that have a link in a docstring like this, but I did find a few examples, and this does seem like a good idea, so let's go for it.
|
@pganssle FYI It is your email that is causing the CI to fail, you have not signed the CLA with the GitHub address. |
3 participants
Addresses issue #97517 by adding links to format codes documentation for all strftime and strptime methods in the datetime module.
Changes Made
strftimemethods in date, time, and datetime classesstrptimemethods in date, time, and datetime classesFormat Used
For a list of supported format codes, see the documentation:
https://docs.python.org/3/library/datetime.html#format-codes
Question
I've updated all the Python docstrings as suggested in the previous PR #132375. Should I also update the C extension docstrings mentioned in that feedback, or is this sufficient to start with?
Closes #97517