Skip to content

Harmonize parameter names in time module documentation (gh-155787) - #155818

Closed
SparshGarg999 wants to merge 2 commits into
python:mainfrom
SparshGarg999:doc-time-module-param-names-155787
Closed

Harmonize parameter names in time module documentation (gh-155787)#155818
SparshGarg999 wants to merge 2 commits into
python:mainfrom
SparshGarg999:doc-time-module-param-names-155787

Conversation

@SparshGarg999

@SparshGarg999 SparshGarg999 commented Aug 15, 2026

Copy link
Copy Markdown

Fixes gh-155787

Context & Documentation Cleanup

Parameter names across the time module documentation (Doc/library/time.rst) and C module docstring signatures previously differed across functions (e.g. using secs in one function vs seconds in another, or t vs tuple). This inconsistency created confusion when reading rendered Sphinx documentation and interactive help() output.

Solution & Changes

  • Harmonized parameter names in Doc/library/time.rst to use consistent, descriptive parameter naming across all time functions (seconds for timestamp arguments, time_tuple for struct_time/tuple arguments).

Testing & Verification

  • Rendered CPython Sphinx documentation locally and verified parameter consistency across time module function signatures.

@python-cla-bot

Copy link
Copy Markdown

The following commit authors need to sign the Contributor License Agreement:

CLA not signed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

awaiting review docs Documentation in the Doc dir skip news

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

Harmonize parameter names in the time module documentation and docstrings

2 participants