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 · ISSUE

Update documenation of machine.RTC

closedby nagylzsopened 2018-04-10updated 2019-12-17

port-esp8266

The documentation has incorrect signature. There is no RTC.init method. The RTC.datetime method has a different signature: it has no tzinfo parameter, and the "day of week" parameter follows the day parameter (instead of the hour).

For details see: https://stackoverflow.com/questions/49757733/micropython-on-esp8266-rtc-does-not-have-an-init-method/49758737#49758737

Assessment

S Sonnet · high

Both issues report problems with machine.RTC documentation — specifically around RTC.init() and the datetime tuple signature. However, they identify different facets: #3710 says RTC.init() doesn't exist at all on ESP8266 and the parameter order is wrong, while #3830 reports that tzinfo in RTC.init() is unspecified and non-functional. #3710 is narrower (ESP8266-specific, doc correctness), while #3830 focuses on tzinfo semantics. Neither resolves the other — fixing the method signature (3710) doesn't address the tzinfo behaviour (3830), and vice versa.

Suggested action

Link both issues as related. Neither closes the other. If a fix lands for the RTC documentation, both should be reviewed to confirm they are addressed. #3830 specifically needs a decision on whether tzinfo should be supported in RTC.init() or removed from the docs.

No format of tzinfo accepted in RTC.init()

Update documenation of machine.RTC

Keyboard