Skip to content

Commit fbd252b

Browse files
committed
docs/{esp,pyb,ubinascii}: Use markup adhering to the latest docs conventions.
1 parent 748f493 commit fbd252b

3 files changed

Lines changed: 10 additions & 10 deletions

File tree

docs/library/esp.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Functions
1414

1515
Get or set the sleep type.
1616

17-
If the ``sleep_type`` parameter is provided, sets the sleep type to its
17+
If the *sleep_type* parameter is provided, sets the sleep type to its
1818
value. If the function is called without parameters, returns the current
1919
sleep type.
2020

@@ -55,23 +55,23 @@ Functions
5555
1MByte of flash (which is memory mapped), and this function controls the
5656
location.
5757

58-
If `start` and `length` are both `None` then the native code location is
58+
If *start* and *length* are both ``None`` then the native code location is
5959
set to the unused portion of memory at the end of the iRAM1 region. The
6060
size of this unused portion depends on the firmware and is typically quite
6161
small (around 500 bytes), and is enough to store a few very small
6262
functions. The advantage of using this iRAM1 region is that it does not
6363
get worn out by writing to it.
6464

65-
If neither `start` nor `length` are `None` then they should be integers.
66-
`start` should specify the byte offset from the beginning of the flash at
67-
which native code should be stored. `length` specifies how many bytes of
68-
flash from `start` can be used to store native code. `start` and `length`
65+
If neither *start* nor *length* are ``None`` then they should be integers.
66+
*start* should specify the byte offset from the beginning of the flash at
67+
which native code should be stored. *length* specifies how many bytes of
68+
flash from *start* can be used to store native code. *start* and *length*
6969
should be multiples of the sector size (being 4096 bytes). The flash will
7070
be automatically erased before writing to it so be sure to use a region of
7171
flash that is not otherwise used, for example by the firmware or the
7272
filesystem.
7373

74-
When using the flash to store native code `start+length` must be less
74+
When using the flash to store native code *start+length* must be less
7575
than or equal to 1MByte. Note that the flash can be worn out if repeated
7676
erasures (and writes) are made so use this feature sparingly.
7777
In particular, native code needs to be recompiled and rewritten to flash

docs/library/pyb.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -85,10 +85,10 @@ Reset related functions
8585
Enable or disable hard-fault debugging. A hard-fault is when there is a fatal
8686
error in the underlying system, like an invalid memory access.
8787

88-
If the `value` argument is `False` then the board will automatically reset if
88+
If the *value* argument is ``False`` then the board will automatically reset if
8989
there is a hard fault.
9090

91-
If `value` is `True` then, when the board has a hard fault, it will print the
91+
If *value* is ``True`` then, when the board has a hard fault, it will print the
9292
registers and the stack trace, and then cycle the LEDs indefinitely.
9393

9494
The default value is disabled, i.e. to automatically reset.

docs/library/ubinascii.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Functions
1717
.. admonition:: Difference to CPython
1818
:class: attention
1919

20-
If additional argument, `sep` is supplied, it is used as a separator
20+
If additional argument, *sep* is supplied, it is used as a separator
2121
between hexadecimal values.
2222

2323
.. function:: unhexlify(data)

0 commit comments

Comments
 (0)