TonBERRY/micropython
3
0
Fork 0
Code Pull Requests Activity

docs: Fix the quickref documentation of rtc.datetime().

Browse Source 
Such that it matches the implementation and the documentation of the
`machine.RTC` class.

Signed-off-by: robert-hh <robert@hammelrath.com>
This commit is contained in:
robert-hh
2023-01-28 10:12:49 +01:00
committed by Damien George
parent e323da7291
commit b5de529ffc
6 changed files with 17 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/esp32/quickref.rst
View File

@@ -577,7 +577,9 @@ See :ref:`machine.RTC <machine.RTC>` ::
from machine import RTC from machine import RTC
rtc = RTC() rtc = RTC()
rtc.datetime((2017, 8, 23, 1, 12, 48, 0, 0)) # set a specific date and time rtc.datetime((2017, 8, 23, 0, 1, 12, 48, 0)) # set a specific date and
# time, eg. 2017/8/23 1:12:48
# the day-of-week value is ignored
rtc.datetime() # get date and time rtc.datetime() # get date and time
WDT (Watchdog timer) WDT (Watchdog timer)

4
docs/esp8266/quickref.rst
View File

@@ -284,7 +284,9 @@ See :ref:`machine.RTC <machine.RTC>` ::
from machine import RTC from machine import RTC
rtc = RTC() rtc = RTC()
rtc.datetime((2017, 8, 23, 1, 12, 48, 0, 0)) # set a specific date and time rtc.datetime((2017, 8, 23, 0, 1, 12, 48, 0)) # set a specific date and
# time, eg. 2017/8/23 1:12:48
# the day-of-week value is ignored
rtc.datetime() # get date and time rtc.datetime() # get date and time
# synchronize with ntp # synchronize with ntp

4
docs/mimxrt/quickref.rst
View File

@@ -429,7 +429,9 @@ See :ref:`machine.RTC <machine.RTC>`::
from machine import RTC from machine import RTC
rtc = RTC() rtc = RTC()
rtc.datetime((2017, 8, 23, 1, 12, 48, 0, 0)) # set a specific date and time rtc.datetime((2017, 8, 23, 0, 1, 12, 48, 0)) # set a specific date and
# time, eg. 2017/8/23 1:12:48
# the day-of-week value is ignored
rtc.datetime() # get date and time rtc.datetime() # get date and time
rtc.now() # return date and time in CPython format. rtc.now() # return date and time in CPython format.

4
docs/pyboard/quickref.rst
View File

@@ -138,7 +138,9 @@ See :ref:`pyb.RTC <pyb.RTC>` ::
from pyb import RTC from pyb import RTC
rtc = RTC() rtc = RTC()
rtc.datetime((2017, 8, 23, 1, 12, 48, 0, 0)) # set a specific date and time rtc.datetime((2017, 8, 23, 0, 1, 12, 48, 0)) # set a specific date and
# time, eg. 2017/8/23 1:12:48
# the day-of-week value is ignored
rtc.datetime() # get date and time rtc.datetime() # get date and time
PWM (pulse width modulation) PWM (pulse width modulation)

5
docs/renesas-ra/quickref.rst
View File

@@ -206,8 +206,9 @@ See :ref:`machine.RTC <machine.RTC>` ::
from machine import RTC from machine import RTC
rtc = RTC() rtc = RTC()
rtc.datetime((2017, 8, 23, 1, 12, 48, 0, 0)) # set a specific date and time rtc.datetime((2017, 8, 23, 0, 1, 12, 48, 0)) # set a specific date and
# time, eg 2017/8/23 1:12:48 # time, eg. 2017/8/23 1:12:48
# the day-of-week value is ignored
rtc.datetime() # get date and time rtc.datetime() # get date and time
Following functions are not supported at the present:: Following functions are not supported at the present::

3
docs/rp2/quickref.rst
View File

@@ -310,8 +310,9 @@ See :ref:`machine.RTC <machine.RTC>` ::
from machine import RTC from machine import RTC
rtc = RTC() rtc = RTC()
rtc.datetime((2017, 8, 23, 2, 12, 48, 0, 0)) # set a specific date and rtc.datetime((2017, 8, 23, 0, 1, 12, 48, 0)) # set a specific date and
# time, eg. 2017/8/23 1:12:48 # time, eg. 2017/8/23 1:12:48
# the day-of-week value is ignored
rtc.datetime() # get date and time rtc.datetime() # get date and time
WDT (Watchdog timer) WDT (Watchdog timer)