diff options
| author | Scott Shawcroft <scott@tannewt.org> | 2019-11-01 13:20:58 -0700 |
|---|---|---|
| committer | Scott Shawcroft <scott@tannewt.org> | 2019-11-01 13:20:58 -0700 |
| commit | 47e50e56594f7b6b71191e61415f87bfdb9c6cb6 (patch) | |
| tree | 2b602924a4382cebfa23d14af37e9d393cc55528 /shared-bindings/rtc/__init__.c | |
| parent | 91c9d519ae74923eec7f95dd606f83555a21f751 (diff) | |
| parent | 08d1019f2b8bb2f0153e1019067d8a862c7a03f2 (diff) | |
Merge remote-tracking branch 'adafruit/master' into bleio_tweaks
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 |