diff options
| author | Jos Verlinde <josverl@microsoft.com> | 2021-07-12 18:04:56 +0200 |
|---|---|---|
| committer | Damien George <damien@micropython.org> | 2022-02-09 15:01:00 +1100 |
| commit | cd0531c533c9e3bb6e96ec8d994ae272b58503c6 (patch) | |
| tree | 2c422ec313a8bda5b79c47837843f6d2183a75e0 | |
| parent | a41abd94dcbb5c36cd3a66ae000fa02634472a6c (diff) | |
docs: Use the correct * keyword-only notation.
| -rw-r--r-- | docs/library/machine.PWM.rst | 4 | ||||
| -rw-r--r-- | docs/library/pyb.Pin.rst | 2 | ||||
| -rw-r--r-- | docs/wipy/general.rst | 4 |
3 files changed, 5 insertions, 5 deletions
diff --git a/docs/library/machine.PWM.rst b/docs/library/machine.PWM.rst index 4c72255d8..793c074a3 100644 --- a/docs/library/machine.PWM.rst +++ b/docs/library/machine.PWM.rst @@ -23,7 +23,7 @@ Example usage:: Constructors ------------ -.. class:: PWM(dest, \*, freq, duty_u16, duty_ns) +.. class:: PWM(dest, *, freq, duty_u16, duty_ns) Construct and return a new PWM object using the following parameters: @@ -42,7 +42,7 @@ Constructors Methods ------- -.. method:: PWM.init(\*, freq, duty_u16, duty_ns) +.. method:: PWM.init(*, freq, duty_u16, duty_ns) Modify settings for the PWM object. See the above constructor for details about the parameters. diff --git a/docs/library/pyb.Pin.rst b/docs/library/pyb.Pin.rst index 23ede48ed..33b994e39 100644 --- a/docs/library/pyb.Pin.rst +++ b/docs/library/pyb.Pin.rst @@ -98,7 +98,7 @@ Class methods Methods ------- -.. method:: Pin.init(mode, pull=Pin.PULL_NONE, \*, value=None, alt=-1) +.. method:: Pin.init(mode, pull=Pin.PULL_NONE, *, value=None, alt=-1) Initialise the pin: diff --git a/docs/wipy/general.rst b/docs/wipy/general.rst index 7f24435db..a1c8df8ef 100644 --- a/docs/wipy/general.rst +++ b/docs/wipy/general.rst @@ -345,7 +345,7 @@ Example:: Create a server instance, see ``init`` for parameters of initialization. -.. method:: server.init(\*, login=('micro', 'python'), timeout=300) +.. method:: server.init(*, login=('micro', 'python'), timeout=300) Init (and effectively start the server). Optionally a new ``user``, ``password`` and ``timeout`` (in seconds) can be passed. @@ -368,7 +368,7 @@ Adhoc VFS-like support WiPy doesn't implement full MicroPython VFS support, instead following functions are defined in ``os`` module: -.. function:: mount(block_device, mount_point, \*, readonly=False) +.. function:: mount(block_device, mount_point, *, readonly=False) Mounts a block device (like an ``SD`` object) in the specified mount point. Example:: |