diff options
| author | Zenix27 <30363000+Zenix27@users.noreply.github.com> | 2020-07-11 12:23:26 +0530 |
|---|---|---|
| committer | Damien George <damien@micropython.org> | 2020-08-21 12:24:13 +1000 |
| commit | e76c7466b62c940150cf1b5000e18f60a5efa2e3 (patch) | |
| tree | 0ced7b7a5eb3f5efb6524ca1cf65bd0188b57bc5 /docs/library/machine.TimerWiPy.rst | |
| parent | 17689a71f66bcf96c09f8700fa3e0f5aa5be225c (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.TimerWiPy.rst')
| -rw-r--r-- | docs/library/machine.TimerWiPy.rst | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/library/machine.TimerWiPy.rst b/docs/library/machine.TimerWiPy.rst index 904a958c6..f5b748c62 100644 --- a/docs/library/machine.TimerWiPy.rst +++ b/docs/library/machine.TimerWiPy.rst @@ -39,7 +39,7 @@ Constructors Methods ------- -.. method:: TimerWiPy.init(mode, \*, width=16) +.. method:: TimerWiPy.init(mode, *, width=16) Initialise the timer. Example:: @@ -64,7 +64,7 @@ Methods Deinitialises the timer. Stops the timer, and disables the timer peripheral. -.. method:: TimerWiPy.channel(channel, \**, freq, period, polarity=TimerWiPy.POSITIVE, duty_cycle=0) +.. method:: TimerWiPy.channel(channel, **, freq, period, polarity=TimerWiPy.POSITIVE, duty_cycle=0) If only a channel identifier passed, then a previously initialized channel object is returned (or ``None`` if there is no previous channel). @@ -113,7 +113,7 @@ TimerChannel objects are created using the Timer.channel() method. Methods ------- -.. method:: timerchannel.irq(\*, trigger, priority=1, handler=None) +.. method:: timerchannel.irq(*, trigger, priority=1, handler=None) The behavior of this callback is heavily dependent on the operating mode of the timer channel: |