diff options
| author | Dan Halbert <halbert@halwitz.org> | 2019-12-05 22:45:53 -0500 |
|---|---|---|
| committer | Dan Halbert <halbert@halwitz.org> | 2019-12-05 22:45:53 -0500 |
| commit | 40434d691934cf7f5792f91ce0288beb568bab85 (patch) | |
| tree | e2f7d0191685f0b519e98c3e1551626fbbf49585 /shared-bindings/rtc/__init__.c | |
| parent | 1505da784f228d43df41a773cfe504e7e4da330a (diff) | |
| parent | 15886b1505d854d76e353b9c5261568c7065d2bf (diff) | |
wip
Diffstat (limited to 'shared-bindings/rtc/__init__.c')
| -rw-r--r-- | shared-bindings/rtc/__init__.c | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/shared-bindings/rtc/__init__.c b/shared-bindings/rtc/__init__.c index ac67a7131..22eda9b66 100644 --- a/shared-bindings/rtc/__init__.c +++ b/shared-bindings/rtc/__init__.c @@ -36,12 +36,13 @@ //| //| .. module:: rtc //| :synopsis: Real Time Clock -//| :platform: SAMD21 +//| :platform: SAMD21, SAMD51, nRF52 //| -//| The `rtc` module provides support for a Real Time Clock. -//| It also backs the `time.time()` and `time.localtime()` functions using the onboard RTC if present. +//| The `rtc` module provides support for a Real Time Clock. You can access and manage the +//| RTC using :class:`rtc.RTC`. It also backs the :func:`time.time` and :func:`time.localtime` +//| functions using the onboard RTC if present. //| -//| Libraries +//| Classes //| //| .. toctree:: //| :maxdepth: 3 @@ -63,10 +64,9 @@ mp_obj_t rtc_get_time_source_time(void) { //| .. function:: set_time_source(rtc) //| -//| Sets the rtc time source used by time.localtime(). -//| The default is `rtc.RTC()`. -//| -//| Example usage:: +//| Sets the RTC time source used by :func:`time.localtime`. +//| The default is :class:`rtc.RTC`, but it's useful to use this to override the +//| time source for testing purposes. For example:: //| //| import rtc //| import time |