From fbd252b77cb7eb5b525e757ac7dd20051fd6b673 Mon Sep 17 00:00:00 2001
From: Paul Sokolovsky <pfalcon@users.sourceforge.net>
Date: Tue, 27 Jun 2017 00:38:05 +0300
Subject: [PATCH] docs/{esp,pyb,ubinascii}: Use markup adhering to the latest
docs conventions.
---
docs/library/esp.rst | 14 +++++++-------
docs/library/pyb.rst | 4 ++--
docs/library/ubinascii.rst | 2 +-
3 files changed, 10 insertions(+), 10 deletions(-)
diff --git a/docs/library/esp.rst b/docs/library/esp.rst
index 8cafb92cd..121a80d42 100644
--- a/docs/library/esp.rst
+++ b/docs/library/esp.rst
@@ -14,7 +14,7 @@ Functions
Get or set the sleep type.
- If the ``sleep_type`` parameter is provided, sets the sleep type to its
+ If the *sleep_type* parameter is provided, sets the sleep type to its
value. If the function is called without parameters, returns the current
sleep type.
@@ -55,23 +55,23 @@ Functions
1MByte of flash (which is memory mapped), and this function controls the
location.
- If `start` and `length` are both `None` then the native code location is
+ If *start* and *length* are both ``None`` then the native code location is
set to the unused portion of memory at the end of the iRAM1 region. The
size of this unused portion depends on the firmware and is typically quite
small (around 500 bytes), and is enough to store a few very small
functions. The advantage of using this iRAM1 region is that it does not
get worn out by writing to it.
- If neither `start` nor `length` are `None` then they should be integers.
- `start` should specify the byte offset from the beginning of the flash at
- which native code should be stored. `length` specifies how many bytes of
- flash from `start` can be used to store native code. `start` and `length`
+ If neither *start* nor *length* are ``None`` then they should be integers.
+ *start* should specify the byte offset from the beginning of the flash at
+ which native code should be stored. *length* specifies how many bytes of
+ flash from *start* can be used to store native code. *start* and *length*
should be multiples of the sector size (being 4096 bytes). The flash will
be automatically erased before writing to it so be sure to use a region of
flash that is not otherwise used, for example by the firmware or the
filesystem.
- When using the flash to store native code `start+length` must be less
+ When using the flash to store native code *start+length* must be less
than or equal to 1MByte. Note that the flash can be worn out if repeated
erasures (and writes) are made so use this feature sparingly.
In particular, native code needs to be recompiled and rewritten to flash
diff --git a/docs/library/pyb.rst b/docs/library/pyb.rst
index 9c4933808..a8fef9309 100644
--- a/docs/library/pyb.rst
+++ b/docs/library/pyb.rst
@@ -85,10 +85,10 @@ Reset related functions
Enable or disable hard-fault debugging. A hard-fault is when there is a fatal
error in the underlying system, like an invalid memory access.
- If the `value` argument is `False` then the board will automatically reset if
+ If the *value* argument is ``False`` then the board will automatically reset if
there is a hard fault.
- If `value` is `True` then, when the board has a hard fault, it will print the
+ If *value* is ``True`` then, when the board has a hard fault, it will print the
registers and the stack trace, and then cycle the LEDs indefinitely.
The default value is disabled, i.e. to automatically reset.
diff --git a/docs/library/ubinascii.rst b/docs/library/ubinascii.rst
index 4931f9048..a8d359eb4 100644
--- a/docs/library/ubinascii.rst
+++ b/docs/library/ubinascii.rst
@@ -17,7 +17,7 @@ Functions
.. admonition:: Difference to CPython
:class: attention
- If additional argument, `sep` is supplied, it is used as a separator
+ If additional argument, *sep* is supplied, it is used as a separator
between hexadecimal values.
.. function:: unhexlify(data)
--
GitLab