docs: Use the correct * keyword-only notation.

micropython · Feb 9, 2022 · cd0531c · cd0531c
1 parent a41abd9
commit cd0531c
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 5 deletions.
diff --git 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
@@ -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
@@ -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::