diff options
| author | robert-hh <robert@hammelrath.com> | 2023-01-28 15:19:37 +0100 |
|---|---|---|
| committer | Damien George <damien@micropython.org> | 2024-12-19 16:04:47 +1100 |
| commit | f4e45995232ad52aeb4da270e6ca7571695e339b (patch) | |
| tree | f9174942202f868e4a33f1236f958530bbf5df2e /docs | |
| parent | 0302cd65e85cb255670cf6eb32d9e6cee241128c (diff) | |
| download | micropython-f4e45995232ad52aeb4da270e6ca7571695e339b.tar.gz micropython-f4e45995232ad52aeb4da270e6ca7571695e339b.zip | |
ports: Fix machine.RTC.init() method so argument order matches the docs.
This commit makes the argument ordering of `machine.RTC.init()` the same
for all the ports that implement arguments to this method: cc3200, esp32,
mimxrt and samd. The cc3200 argument ordering is used, which matches the
documentation.
Also document the availability and the differing semantics for the stm32
and renesas-ra port.
Signed-off-by: robert-hh <robert@hammelrath.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/library/machine.RTC.rst | 9 |
1 files changed, 8 insertions, 1 deletions
diff --git a/docs/library/machine.RTC.rst b/docs/library/machine.RTC.rst index ed93c5fff8..e2ddd728bd 100644 --- a/docs/library/machine.RTC.rst +++ b/docs/library/machine.RTC.rst @@ -42,7 +42,14 @@ Methods Initialise the RTC. Datetime is a tuple of the form: - ``(year, month, day[, hour[, minute[, second[, microsecond[, tzinfo]]]]])`` + ``(year, month, day, hour, minute, second, microsecond, tzinfo)`` + + All eight arguments must be present. The ``microsecond`` and ``tzinfo`` + values are currently ignored but might be used in the future. + + Availability: CC3200, ESP32, MIMXRT, SAMD. The rtc.init() method on + the stm32 and renesas-ra ports just (re-)starts the RTC and does not + accept arguments. .. method:: RTC.now() |