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/network.WLANWiPy.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/network.WLANWiPy.rst')
| -rw-r--r-- | docs/library/network.WLANWiPy.rst | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/library/network.WLANWiPy.rst b/docs/library/network.WLANWiPy.rst index b6e327959..2a5ba1184 100644 --- a/docs/library/network.WLANWiPy.rst +++ b/docs/library/network.WLANWiPy.rst @@ -43,7 +43,7 @@ Constructors Methods ------- -.. method:: WLANWiPy.init(mode, \*, ssid, auth, channel, antenna) +.. method:: WLANWiPy.init(mode, *, ssid, auth, channel, antenna) Set or get the WiFi network processor configuration. @@ -69,7 +69,7 @@ Methods # configure as an station wlan.init(mode=WLAN.STA) -.. method:: WLANWiPy.connect(ssid, \*, auth=None, bssid=None, timeout=None) +.. method:: WLANWiPy.connect(ssid, *, auth=None, bssid=None, timeout=None) Connect to a WiFi access point using the given SSID, and other security parameters. @@ -131,7 +131,7 @@ Methods Get or set a 6-byte long bytes object with the MAC address. -.. method:: WLANWiPy.irq(\*, handler, wake) +.. method:: WLANWiPy.irq(*, handler, wake) Create a callback to be triggered when a WLAN event occurs during ``machine.SLEEP`` mode. Events are triggered by socket activity or by WLAN connection/disconnection. |