Skip to content

Commit cd0531c

Browse files
Jos Verlindedpgeorge
Jos Verlinde
authored andcommitted
docs: Use the correct * keyword-only notation.
1 parent a41abd9 commit cd0531c

File tree

3 files changed

+5
-5
lines changed

3 files changed

+5
-5
lines changed

docs/library/machine.PWM.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Example usage::
2323
Constructors
2424
------------
2525

26-
.. class:: PWM(dest, \*, freq, duty_u16, duty_ns)
26+
.. class:: PWM(dest, *, freq, duty_u16, duty_ns)
2727

2828
Construct and return a new PWM object using the following parameters:
2929

@@ -42,7 +42,7 @@ Constructors
4242
Methods
4343
-------
4444

45-
.. method:: PWM.init(\*, freq, duty_u16, duty_ns)
45+
.. method:: PWM.init(*, freq, duty_u16, duty_ns)
4646

4747
Modify settings for the PWM object. See the above constructor for details
4848
about the parameters.

docs/library/pyb.Pin.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ Class methods
9898
Methods
9999
-------
100100

101-
.. method:: Pin.init(mode, pull=Pin.PULL_NONE, \*, value=None, alt=-1)
101+
.. method:: Pin.init(mode, pull=Pin.PULL_NONE, *, value=None, alt=-1)
102102

103103
Initialise the pin:
104104

docs/wipy/general.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -345,7 +345,7 @@ Example::
345345

346346
Create a server instance, see ``init`` for parameters of initialization.
347347

348-
.. method:: server.init(\*, login=('micro', 'python'), timeout=300)
348+
.. method:: server.init(*, login=('micro', 'python'), timeout=300)
349349

350350
Init (and effectively start the server). Optionally a new ``user``, ``password``
351351
and ``timeout`` (in seconds) can be passed.
@@ -368,7 +368,7 @@ Adhoc VFS-like support
368368
WiPy doesn't implement full MicroPython VFS support, instead following
369369
functions are defined in ``os`` module:
370370

371-
.. function:: mount(block_device, mount_point, \*, readonly=False)
371+
.. function:: mount(block_device, mount_point, *, readonly=False)
372372

373373
Mounts a block device (like an ``SD`` object) in the specified mount
374374
point. Example::

0 commit comments

Comments
 (0)