Skip to content

gh-155787: Harmonize parameter names in the time module documentation and docstrings - #155790

Merged
StanFromIreland merged 6 commits into
python:mainfrom
serhiy-storchaka:time-doc-param-names
Aug 14, 2026
Merged

gh-155787: Harmonize parameter names in the time module documentation and docstrings#155790
StanFromIreland merged 6 commits into
python:mainfrom
serhiy-storchaka:time-doc-param-names

Conversation

@serhiy-storchaka

@serhiy-storchaka serhiy-storchaka commented Aug 14, 2026 •
edited by bedevere-app Bot
Loading

Copy link
Copy Markdown
Member

Use seconds and time_tuple in both the documentation and the docstrings, and mark the optional arguments of ctime() and strptime() as optional in the docstrings.

@serhiy-storchaka
pythongh-155787: Harmonize parameter names in the time module documen…
c4dc3e9 
…tation and docstrings

Use "seconds" and "time_tuple" in both the documentation and the
docstrings, and mark the optional arguments of ctime() and strptime()
as optional in the docstrings.
@serhiy-storchaka serhiy-storchaka added needs backport to 3.14 bugs and security fixes needs backport to 3.15 pre-release feature fixes, bugs and security fixes skip news labels Aug 14, 2026
@bedevere-app bedevere-app Bot mentioned this pull request Aug 14, 2026
Closed
StanFromIreland
StanFromIreland reviewed Aug 14, 2026
View reviewed changes
Comment thread Doc/library/time.rst
@read-the-docs-community

read-the-docs-community Bot commented Aug 14, 2026 •
edited
Loading

Copy link
Copy Markdown

Documentation build overview

📚 cpython-previews | 🛠️ Build #34072067 | 📁 Comparing 2f79e78 against main (0d87a0b)

  🔍 Preview build  

4 files changed
± library/annotationlib.html
± library/audit_events.html
± library/time.html
± whatsnew/changelog.html

@serhiy-storchaka serhiy-storchaka added the needs backport to 3.13 bugs and security fixes label Aug 14, 2026
StanFromIreland
StanFromIreland reviewed Aug 14, 2026
View reviewed changes

@StanFromIreland StanFromIreland left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Two last things.

Comment thread Doc/library/time.rst Outdated

@StanFromIreland StanFromIreland Aug 14, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Please mark all pos-only parameters.

Comment thread Doc/library/time.rst Outdated
StanFromIreland
StanFromIreland approved these changes Aug 14, 2026
View reviewed changes

@StanFromIreland StanFromIreland left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM

Comment thread Doc/library/time.rst Outdated
@StanFromIreland
StanFromIreland enabled auto-merge (squash) August 14, 2026 17:50
@StanFromIreland

StanFromIreland commented Aug 14, 2026

Copy link
Copy Markdown
Member

Enabled auto merge, thanks for the PR Serhiy.

@StanFromIreland
StanFromIreland merged commit bc6749c into python:main Aug 14, 2026
54 checks passed
@miss-islington-app

miss-islington-app Bot commented Aug 14, 2026

Copy link
Copy Markdown

Thanks @serhiy-storchaka for the PR, and @StanFromIreland for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13, 3.14, 3.15.
🐍🍒⛏🤖

@miss-islington-app

miss-islington-app Bot commented Aug 14, 2026

Copy link
Copy Markdown

Sorry, @serhiy-storchaka and @StanFromIreland, I could not cleanly backport this to 3.14 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker bc6749cc3b5ae4a5e88a6cc2d5b3bebbe354eae6 3.14

@bedevere-app

bedevere-app Bot commented Aug 14, 2026

Copy link
Copy Markdown

GH-155804 is a backport of this pull request to the 3.15 branch.

@bedevere-app bedevere-app Bot removed the needs backport to 3.15 pre-release feature fixes, bugs and security fixes label Aug 14, 2026
@miss-islington-app

miss-islington-app Bot commented Aug 14, 2026

Copy link
Copy Markdown

Sorry, @serhiy-storchaka and @StanFromIreland, I could not cleanly backport this to 3.13 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker bc6749cc3b5ae4a5e88a6cc2d5b3bebbe354eae6 3.13

@bedevere-app

bedevere-app Bot commented Aug 14, 2026

Copy link
Copy Markdown

GH-155806 is a backport of this pull request to the 3.14 branch.

@bedevere-app bedevere-app Bot removed the needs backport to 3.14 bugs and security fixes label Aug 14, 2026
@bedevere-app

bedevere-app Bot commented Aug 14, 2026

Copy link
Copy Markdown

GH-155807 is a backport of this pull request to the 3.13 branch.

@bedevere-app bedevere-app Bot removed the needs backport to 3.13 bugs and security fixes label Aug 14, 2026
serhiy-storchaka added a commit that referenced this pull request Aug 15, 2026
@serhiy-storchaka @StanFromIreland
[3.14] gh-155787: Harmonize parameter names in the time module docume…
4dbd529 
…ntation and docstrings (GH-155790) (GH-155806)

(cherry picked from commit bc6749c)

Co-authored-by: Stan Ulbrych <stan@python.org>
serhiy-storchaka added a commit that referenced this pull request Aug 15, 2026
@serhiy-storchaka @StanFromIreland
[3.13] gh-155787: Harmonize parameter names in the time module docume…
e4046ce 
…ntation and docstrings (GH-155790) (GH-155807)

(cherry picked from commit bc6749c)

Co-authored-by: Stan Ulbrych <stan@python.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@StanFromIreland StanFromIreland StanFromIreland approved these changes
@pganssle pganssle Awaiting requested review from pganssle pganssle is a code owner

Assignees

@StanFromIreland StanFromIreland

Labels

skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@serhiy-storchaka @StanFromIreland