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/pyb.USB_VCP.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/pyb.USB_VCP.rst')
| -rw-r--r-- | docs/library/pyb.USB_VCP.rst | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/library/pyb.USB_VCP.rst b/docs/library/pyb.USB_VCP.rst index b16924cf6..bbcbc0701 100644 --- a/docs/library/pyb.USB_VCP.rst +++ b/docs/library/pyb.USB_VCP.rst @@ -21,7 +21,7 @@ Constructors Methods ------- -.. method:: USB_VCP.init(\*, flow=-1) +.. method:: USB_VCP.init(*, flow=-1) Configure the USB VCP port. If the *flow* argument is not -1 then the value sets the flow control, which can be a bitwise-or of ``USB_VCP.RTS`` and ``USB_VCP.CTS``. @@ -89,7 +89,7 @@ Methods Returns the number of bytes written. -.. method:: USB_VCP.recv(data, \*, timeout=5000) +.. method:: USB_VCP.recv(data, *, timeout=5000) Receive data on the bus: @@ -100,7 +100,7 @@ Methods Return value: if ``data`` is an integer then a new buffer of the bytes received, otherwise the number of bytes read into ``data`` is returned. -.. method:: USB_VCP.send(data, \*, timeout=5000) +.. method:: USB_VCP.send(data, *, timeout=5000) Send data over the USB VCP: |