summaryrefslogtreecommitdiff
path: root/shared-bindings/rtc
diff options
context:
space:
mode:
Diffstat (limited to 'shared-bindings/rtc')
-rw-r--r--shared-bindings/rtc/RTC.c8
1 files changed, 7 insertions, 1 deletions
diff --git a/shared-bindings/rtc/RTC.c b/shared-bindings/rtc/RTC.c
index 4a792484d..5e6b00c6e 100644
--- a/shared-bindings/rtc/RTC.c
+++ b/shared-bindings/rtc/RTC.c
@@ -98,7 +98,13 @@ const mp_obj_property_t rtc_rtc_datetime_obj = {
//| """The RTC calibration value as an `int`.
//|
//| A positive value speeds up the clock and a negative value slows it down.
-//| Range and value is hardware specific, but one step is often approximately 1 ppm."""
+//| Range and value is hardware specific, but one step is often approximately 1 ppm::
+//|
+//| import rtc
+//| import time
+//|
+//| r = rtc.RTC()
+//| r.calibration = 1"""
//|
STATIC mp_obj_t rtc_rtc_obj_get_calibration(mp_obj_t self_in) {
int calibration = common_hal_rtc_get_calibration();