Skip to content

Commit 621b5db

Browse files
committed
Improvements to docs.
1 parent fa38336 commit 621b5db

File tree

1 file changed

+8
-9
lines changed

1 file changed

+8
-9
lines changed

TUTORIAL.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -64,9 +64,7 @@ and rebuilding.
6464
# Contents
6565

6666
1. [Cooperative scheduling](./TUTORIAL.md#1-cooperative-scheduling)
67-
6867
1.1 [Modules](./TUTORIAL.md#11-modules)
69-
7068
2. [uasyncio](./TUTORIAL.md#2-uasyncio)
7169

7270
2.1 [Program structure: the event loop](./TUTORIAL.md#21-program-structure-the-event-loop)
@@ -1529,11 +1527,11 @@ I have [a PR](https://github.com/micropython/micropython-lib/pull/292) which
15291527
proposes a fix for case 1. The [fast_io](./FASTPOLL.md) version implements
15301528
this.
15311529

1532-
The script `check_async_code.py` attempts to locate instances of questionable
1533-
use of coros. It is intended to be run on a PC and uses Python3. It takes a
1534-
single argument, a path to a MicroPython sourcefile (or `--help`). It is
1535-
designed for use on scripts written according to the guidelines in this
1536-
tutorial, with coros declared using `async def`.
1530+
The script [check_async_code.py](./check_async_code.py) attempts to locate
1531+
instances of questionable use of coros. It is intended to be run on a PC and
1532+
uses Python3. It takes a single argument, a path to a MicroPython sourcefile
1533+
(or `--help`). It is designed for use on scripts written according to the
1534+
guidelines in this tutorial, with coros declared using `async def`.
15371535

15381536
Note it is somewhat crude and intended to be used on a syntactically correct
15391537
file which is silently failing to run. Use a tool such as `pylint` for general
@@ -1573,8 +1571,9 @@ practice a timeout is likely to be required to cope with server outages.
15731571
A further complication is that, at the time of writing, the ESP32 port has
15741572
issues which require rather unpleasant hacks for error-free operation.
15751573

1576-
The file [sock_nonblock.py](./sock_nonblock.py) illustrates the sort of techniques required. It is
1577-
not a working demo, and solutions are likely to be application dependent.
1574+
The file [sock_nonblock.py](./sock_nonblock.py) illustrates the sort of
1575+
techniques required. It is not a working demo, and solutions are likely to be
1576+
application dependent.
15781577

15791578
An alternative approach is to use blocking sockets with `StreamReader` and
15801579
`StreamWriter` instances to control polling.

0 commit comments

Comments
 (0)