mirrors
/
micropython
mirror of https://github.com/micropython/micropython.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: Use the correct * keyword-only notation.

This commit is contained in:
Jos Verlinde 2021-07-12 18:04:56 +02:00 committed by Damien George
parent a41abd94dc
commit cd0531c533
3 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/library/machine.PWM.rst
View File

@ -23,7 +23,7 @@ Example usage::
Constructors 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: Construct and return a new PWM object using the following parameters:
@ -42,7 +42,7 @@ Constructors
Methods 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 Modify settings for the PWM object. See the above constructor for details
about the parameters. about the parameters.

2
docs/library/pyb.Pin.rst
View File

@ -98,7 +98,7 @@ Class methods
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: Initialise the pin:

4
docs/wipy/general.rst
View File

@ -345,7 +345,7 @@ Example::
Create a server instance, see ``init`` for parameters of initialization. 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`` Init (and effectively start the server). Optionally a new ``user``, ``password``
and ``timeout`` (in seconds) can be passed. 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 WiPy doesn't implement full MicroPython VFS support, instead following
functions are defined in ``os`` module: 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 Mounts a block device (like an ``SD`` object) in the specified mount
point. Example:: point. Example::