Skip to content

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

Open
serhiy-storchaka wants to merge 5 commits into
python:mainfrom
serhiy-storchaka:time-doc-param-names
Open

gh-155787: Harmonize parameter names in the time module documentation and docstrings#155790
serhiy-storchaka wants to merge 5 commits into
python:mainfrom
serhiy-storchaka:time-doc-param-names

Conversation

@serhiy-storchaka

@serhiy-storchaka serhiy-storchaka commented Aug 14, 2026

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.

…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.
Comment thread Doc/library/time.rst
@read-the-docs-community

read-the-docs-community Bot commented Aug 14, 2026

Copy link
Copy Markdown

Documentation build overview

📚 cpython-previews | 🛠️ Build #34068368 | 📁 Comparing cc9aa28 against main (0d87a0b)

  🔍 Preview build  

3 files changed
± library/annotationlib.html
± library/audit_events.html
± library/time.html

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

@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

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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

awaiting core review needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes needs backport to 3.15 pre-release feature fixes, bugs and security fixes skip news

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants