summaryrefslogtreecommitdiff
path: root/docs/library/machine.RTC.rst
diff options
context:
space:
mode:
authorZenix27 <30363000+Zenix27@users.noreply.github.com>2020-07-11 12:23:26 +0530
committerDamien George <damien@micropython.org>2020-08-21 12:24:13 +1000
commite76c7466b62c940150cf1b5000e18f60a5efa2e3 (patch)
tree0ced7b7a5eb3f5efb6524ca1cf65bd0188b57bc5 /docs/library/machine.RTC.rst
parent17689a71f66bcf96c09f8700fa3e0f5aa5be225c (diff)
docs: Change `\*` to `*` in argument lists.
Latest versions of Sphinx (at least 3.1.0) do not need the `*` escaped and will render the `\` in the output if it is there, so remove it. Fixes issue #6209.
Diffstat (limited to 'docs/library/machine.RTC.rst')
-rw-r--r--docs/library/machine.RTC.rst4
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/library/machine.RTC.rst b/docs/library/machine.RTC.rst
index 548ad007e..d5a4f390b 100644
--- a/docs/library/machine.RTC.rst
+++ b/docs/library/machine.RTC.rst
@@ -38,7 +38,7 @@ Methods
Resets the RTC to the time of January 1, 2015 and starts running it again.
-.. method:: RTC.alarm(id, time, \*, repeat=False)
+.. method:: RTC.alarm(id, time, *, repeat=False)
Set the RTC alarm. Time might be either a millisecond value to program the alarm to
current time + time_in_ms in the future, or a datetimetuple. If the time passed is in
@@ -52,7 +52,7 @@ Methods
Cancel a running alarm.
-.. method:: RTC.irq(\*, trigger, handler=None, wake=machine.IDLE)
+.. method:: RTC.irq(*, trigger, handler=None, wake=machine.IDLE)
Create an irq object triggered by a real time clock alarm.