Skip to content

Commit dd16e21

Browse files
committed
docs/network: Use markup adhering to the latest docs conventions.
1 parent 7c0e1f1 commit dd16e21

1 file changed

Lines changed: 26 additions & 26 deletions

File tree

docs/library/network.rst

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ parameter should be `id`.
7272
connection parameters. For various medium types, there are different
7373
sets of predefined/recommended parameters, among them:
7474

75-
* WiFi: `bssid` keyword to connect by BSSID (MAC address) instead
75+
* WiFi: *bssid* keyword to connect by BSSID (MAC address) instead
7676
of access point name
7777

7878
.. method:: disconnect()
@@ -118,7 +118,7 @@ parameter should be `id`.
118118

119119
Get or set general network interface parameters. These methods allow to work
120120
with additional parameters beyond standard IP configuration (as dealt with by
121-
``ifconfig()``). These include network-specific and hardware-specific
121+
`ifconfig()`). These include network-specific and hardware-specific
122122
parameters and status values. For setting parameters, the keyword argument
123123
syntax should be used, and multiple parameters can be set at once. For
124124
querying, a parameter name should be quoted as a string, and only one
@@ -170,11 +170,11 @@ parameter should be `id`.
170170

171171
Arguments are:
172172

173-
- ``spi`` is an :ref:`SPI object <pyb.SPI>` which is the SPI bus that the CC3000 is
173+
- *spi* is an :ref:`SPI object <pyb.SPI>` which is the SPI bus that the CC3000 is
174174
connected to (the MOSI, MISO and CLK pins).
175-
- ``pin_cs`` is a :ref:`Pin object <pyb.Pin>` which is connected to the CC3000 CS pin.
176-
- ``pin_en`` is a :ref:`Pin object <pyb.Pin>` which is connected to the CC3000 VBEN pin.
177-
- ``pin_irq`` is a :ref:`Pin object <pyb.Pin>` which is connected to the CC3000 IRQ pin.
175+
- *pin_cs* is a :ref:`Pin object <pyb.Pin>` which is connected to the CC3000 CS pin.
176+
- *pin_en* is a :ref:`Pin object <pyb.Pin>` which is connected to the CC3000 VBEN pin.
177+
- *pin_irq* is a :ref:`Pin object <pyb.Pin>` which is connected to the CC3000 IRQ pin.
178178

179179
All of these objects will be initialised by the driver, so there is no need to
180180
initialise them yourself. For example, you can use::
@@ -256,10 +256,10 @@ parameter should be `id`.
256256

257257
Arguments are:
258258

259-
- ``spi`` is an :ref:`SPI object <pyb.SPI>` which is the SPI bus that the WIZnet5x00 is
259+
- *spi* is an :ref:`SPI object <pyb.SPI>` which is the SPI bus that the WIZnet5x00 is
260260
connected to (the MOSI, MISO and SCLK pins).
261-
- ``pin_cs`` is a :ref:`Pin object <pyb.Pin>` which is connected to the WIZnet5x00 nSS pin.
262-
- ``pin_rst`` is a :ref:`Pin object <pyb.Pin>` which is connected to the WIZnet5x00 nRESET pin.
261+
- *pin_cs* is a :ref:`Pin object <pyb.Pin>` which is connected to the WIZnet5x00 nSS pin.
262+
- *pin_rst* is a :ref:`Pin object <pyb.Pin>` which is connected to the WIZnet5x00 nRESET pin.
263263

264264
All of these objects will be initialised by the driver, so there is no need to
265265
initialise them yourself. For example, you can use::
@@ -294,7 +294,7 @@ parameter should be `id`.
294294

295295
Get or set the PHY mode.
296296

297-
If the ``mode`` parameter is provided, sets the mode to its value. If
297+
If the *mode* parameter is provided, sets the mode to its value. If
298298
the function is called without parameters, returns the current mode.
299299

300300
The possible modes are defined as constants:
@@ -322,7 +322,7 @@ parameter should be `id`.
322322
``network.STA_IF`` (station aka client, connects to upstream WiFi access
323323
points) and ``network.AP_IF`` (access point, allows other WiFi clients to
324324
connect). Availability of the methods below depends on interface type.
325-
For example, only STA interface may ``connect()`` to an access point.
325+
For example, only STA interface may `connect()` to an access point.
326326

327327
Methods
328328
-------
@@ -350,8 +350,8 @@ parameter should be `id`.
350350

351351
(ssid, bssid, channel, RSSI, authmode, hidden)
352352

353-
`bssid` is hardware address of an access point, in binary form, returned as
354-
bytes object. You can use ``ubinascii.hexlify()`` to convert it to ASCII form.
353+
*bssid* is hardware address of an access point, in binary form, returned as
354+
bytes object. You can use `ubinascii.hexlify()` to convert it to ASCII form.
355355

356356
There are five values for authmode:
357357

@@ -399,7 +399,7 @@ parameter should be `id`.
399399

400400
Get or set general network interface parameters. These methods allow to work
401401
with additional parameters beyond standard IP configuration (as dealt with by
402-
``wlan.ifconfig()``). These include network-specific and hardware-specific
402+
`wlan.ifconfig()`). These include network-specific and hardware-specific
403403
parameters. For setting parameters, keyword argument syntax should be used,
404404
multiple parameters can be set at once. For querying, parameters name should
405405
be quoted as a string, and only one parameter can be queries at time::
@@ -450,7 +450,7 @@ parameter should be `id`.
450450

451451
.. class:: WLAN(id=0, ...)
452452

453-
Create a WLAN object, and optionally configure it. See ``init`` for params of configuration.
453+
Create a WLAN object, and optionally configure it. See `init()` for params of configuration.
454454

455455
.. note::
456456

@@ -469,14 +469,14 @@ parameter should be `id`.
469469

470470
Arguments are:
471471

472-
- ``mode`` can be either ``WLAN.STA`` or ``WLAN.AP``.
473-
- ``ssid`` is a string with the ssid name. Only needed when mode is ``WLAN.AP``.
474-
- ``auth`` is a tuple with (sec, key). Security can be ``None``, ``WLAN.WEP``,
472+
- *mode* can be either ``WLAN.STA`` or ``WLAN.AP``.
473+
- *ssid* is a string with the ssid name. Only needed when mode is ``WLAN.AP``.
474+
- *auth* is a tuple with (sec, key). Security can be ``None``, ``WLAN.WEP``,
475475
``WLAN.WPA`` or ``WLAN.WPA2``. The key is a string with the network password.
476476
If ``sec`` is ``WLAN.WEP`` the key must be a string representing hexadecimal
477477
values (e.g. 'ABC1DE45BF'). Only needed when mode is ``WLAN.AP``.
478-
- ``channel`` a number in the range 1-11. Only needed when mode is ``WLAN.AP``.
479-
- ``antenna`` selects between the internal and the external antenna. Can be either
478+
- *channel* a number in the range 1-11. Only needed when mode is ``WLAN.AP``.
479+
- *antenna* selects between the internal and the external antenna. Can be either
480480
``WLAN.INT_ANT`` or ``WLAN.EXT_ANT``.
481481

482482
For example, you can do::
@@ -494,13 +494,13 @@ parameter should be `id`.
494494
Connect to a WiFi access point using the given SSID, and other security
495495
parameters.
496496

497-
- ``auth`` is a tuple with (sec, key). Security can be ``None``, ``WLAN.WEP``,
497+
- *auth* is a tuple with (sec, key). Security can be ``None``, ``WLAN.WEP``,
498498
``WLAN.WPA`` or ``WLAN.WPA2``. The key is a string with the network password.
499499
If ``sec`` is ``WLAN.WEP`` the key must be a string representing hexadecimal
500500
values (e.g. 'ABC1DE45BF').
501-
- ``bssid`` is the MAC address of the AP to connect to. Useful when there are several
501+
- *bssid* is the MAC address of the AP to connect to. Useful when there are several
502502
APs with the same ssid.
503-
- ``timeout`` is the maximum time in milliseconds to wait for the connection to succeed.
503+
- *timeout* is the maximum time in milliseconds to wait for the connection to succeed.
504504

505505
.. method:: wlan.scan()
506506

@@ -518,7 +518,7 @@ parameter should be `id`.
518518

519519
.. method:: wlan.ifconfig(if_id=0, config=['dhcp' or configtuple])
520520

521-
With no parameters given returns a 4-tuple of ``(ip, subnet_mask, gateway, DNS_server)``.
521+
With no parameters given returns a 4-tuple of *(ip, subnet_mask, gateway, DNS_server)*.
522522

523523
if ``'dhcp'`` is passed as a parameter then the DHCP client is enabled and the IP params
524524
are negotiated with the AP.
@@ -556,8 +556,8 @@ parameter should be `id`.
556556
Create a callback to be triggered when a WLAN event occurs during ``machine.SLEEP``
557557
mode. Events are triggered by socket activity or by WLAN connection/disconnection.
558558

559-
- ``handler`` is the function that gets called when the IRQ is triggered.
560-
- ``wake`` must be ``machine.SLEEP``.
559+
- *handler* is the function that gets called when the IRQ is triggered.
560+
- *wake* must be ``machine.SLEEP``.
561561

562562
Returns an IRQ object.
563563

0 commit comments

Comments
 (0)