diff options
| author | Alessandro Gatti <a.gatti@frob.it> | 2024-11-12 07:16:38 +0100 |
|---|---|---|
| committer | Damien George <damien@micropython.org> | 2024-12-10 12:16:03 +1100 |
| commit | e8c3f31ba2e5f004dfb972131d5f7d7a961974c2 (patch) | |
| tree | d9f73e45f45c9b8786adc98c575e71a68a90f081 /docs/esp32/tutorial | |
| parent | 28b52446669b72f9863902510430bdeeaaa39fa6 (diff) | |
| download | micropython-e8c3f31ba2e5f004dfb972131d5f7d7a961974c2.tar.gz micropython-e8c3f31ba2e5f004dfb972131d5f7d7a961974c2.zip | |
mimxrt/machine_rtc: Deprecate RTC.cancel in MicroPython v2.
The current documentation for the `machine.RTC` class contains information
about the `RTC.cancel` method for cancelling pending alarms.
However only two ports (cc3200 and mimxrt) implement this functionality
but under a different name: `RTC.alarm_cancel`. The mimxrt port also
implements `RTC.cancel` but it is aliased to `RTC.alarm_cancel` anyway.
To maintain naming consistency, this commit updates the documentation to
officially define `RTC.alarm_cancel` as the method to call to cancel
pending alarms and deprecates mimxrt's `RTC.cancel` implementation.
`RTC.cancel` in the mimxrt port is thus scheduled for removal in
MicroPython v2.
Signed-off-by: Alessandro Gatti <a.gatti@frob.it>
Diffstat (limited to 'docs/esp32/tutorial')
0 files changed, 0 insertions, 0 deletions