QUERY · ISSUE

docs: time.mktime requires one positional argument

openby maxi07opened 2024-12-29updated 2025-10-03

docs

Documentation URL

No response

Description

when running the function time.mktime(), an exception occurs as the function does require one positional argument. But this is not documented, although it states "t’s argument is a full 8-tuple" inside the description.

Code of Conduct

Yes, I agree

CANDIDATE · PULL REQUEST

docs: utime: Mention that mktime() is not available on all ports.

closedby pfalconopened 2019-03-06updated 2019-12-28

docs

The description of utime.mktime() is quite adhoc, not compatible with
CPython, hard to implement (or not much useful) in the case of lack
of always-powered RTC. That means that it doesn't make sense for all
ports, and various ports don't implement it, starting from the Unix
port.

Change-Id: I01855921dce038bf0df89f0bc916b564c3935a62

Assessment

Q Qwen · high

Issue #16500 reports that the documentation for time.mktime() doesn't clearly specify that it requires one positional argument (an 8-tuple), despite mentioning the tuple in the description. PR #4583 addresses a different documentation issue - it adds a note about mktime() not being available on all ports due to RTC requirements. While both items are documentation-related and concern the same function (mktime), they address different problems. PR #4583 does not resolve the issue raised in #16500 about clarifying the function signature/argument requirements.

Suggested action

Keep both items open. Issue #16500 should be addressed with documentation that clarifies the required 8-tuple argument for time.mktime(), while PR #4583 can proceed as it addresses port availability concerns.