QUERY · ISSUE

No format of tzinfo accepted in RTC.init()

openby VipSaranopened 2018-05-31updated 2018-06-01

Documentation defines RTC.init() method accepting tzinfo argument:

.. method:: RTC.init(datetime)

   Initialise the RTC. Datetime is a tuple of the form:

      ``(year, month, day[, hour[, minute[, second[, microsecond[, tzinfo]]]]])``

But not just that that docu doesn't specify format (Object/String) of the tzinfo it also "doesn't work".

CANDIDATE · PULL REQUEST

docs: Make the machine.RTC reflect reality on esp8266

closedby deshipuopened 2016-08-20updated 2019-08-31

The documentation for machine.RTC is completely worng, not only
specifying wrong method names, but also wrong order of values in
the time tuple. Updated based on the source code.

Assessment

S Sonnet · high

PR #2334 corrects the machine.RTC documentation for esp8266 by replacing tzinfo with weekday in the time tuple definition — directly overlapping with the query's complaint that tzinfo is documented but unspecified and non-functional. However, the PR is scoped to esp8266's documentation and does not address whether tzinfo works (or should be removed) across all ports. The query's concern about the parameter being non-functional remains open beyond the doc fix.

Suggested action

Reference PR #2334 as prior context when investigating issue #3830. The PR already corrected the esp8266 docs to use `weekday` instead of `tzinfo`, which confirms the docs were wrong. The remaining work is to audit other ports' RTC documentation and implementations for the same inconsistency, and determine whether `tzinfo` should be formally unsupported or properly implemented.

No format of tzinfo accepted in RTC.init()

docs: Make the machine.RTC reflect reality on esp8266

Keyboard