Skip to content

Commit e4b6560

Browse files
committed
Fix broken links etc.
1 parent 74ec360 commit e4b6560

File tree

3 files changed

+9
-8
lines changed

3 files changed

+9
-8
lines changed

v3/README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# 1 Guide to uasyncio V3
1+
# 1. Guide to uasyncio V3
22

33
The new release of `uasyncio` is pre-installed in current daily firmware
44
builds. This complete rewrite of `uasyncio` supports CPython 3.8 syntax. A
@@ -28,11 +28,12 @@ useful in their own right:
2828
* [GPS driver](./docs/GPS.md) Includes various GPS utilities.
2929
* [HTU21D](./docs/HTU21D.md) Temperature and humidity sensor.
3030
* [I2C](./docs/I2C.md) Use Pyboard I2C slave mode to implement a UART-like
31-
asynchronous stream interface. Typical use: communication with ESP8266.
31+
asynchronous stream interface. Uses: communication with ESP8266, or (with
32+
coding) interface a Pyboard to I2C masters.
3233
* [NEC IR](./docs/NEC_IR.md) A receiver for signals from IR remote controls
3334
using the popular NEC protocol.
3435

35-
# 2 V3 Overview
36+
# 2. V3 Overview
3637

3738
These notes are intended for users familiar with `asyncio` under CPython.
3839

@@ -66,7 +67,7 @@ supported.
6667
The `Future` class is not supported, nor are the `event_loop` methods
6768
`call_soon`, `call_later`, `call_at`.
6869

69-
# 3 Porting applications from V2
70+
# 3. Porting applications from V2
7071

7172
Many applications using the coding style advocated in the V2 tutorial will work
7273
unchanged. However there are changes, firstly to `uasyncio` itself and secondly
@@ -93,7 +94,7 @@ MicroPython and CPython 3.8. This is discussed
9394
### 3.1.2 Change to stream I/O
9495

9596
Classes based on `uio.IOBase` will need changes to the `write` method. See
96-
[tutorial](./docs/TUTORIAL.md##64-writing-streaming-device-drivers).
97+
[tutorial](./docs/TUTORIAL.md#64-writing-streaming-device-drivers).
9798

9899
## 3.2 Modules from this repository
99100

@@ -143,7 +144,7 @@ New versions are provided in this repository. Classes:
143144
* `Switch` Debounced switch with close and open callbacks.
144145
* `Pushbutton` Pushbutton with double-click and long press callbacks.
145146

146-
# 4 Outstanding issues with V3
147+
# 4. Outstanding issues with V3
147148

148149
V3 is still a work in progress. The following is a list of issues which I hope
149150
will be addressed in due course.

v3/docs/I2C.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ application and is covered in detail
3131
## Changes
3232

3333
V0.18 Apr 2020 Ported to `uasyncio` V3. Convert to Python package. Test script
34-
pin numbers changed to be WBUS_DIP28 fiendly.
34+
pin numbers changed to be WBUS_DIP28 fiendly.
3535
V0.17 Dec 2018 Initiator: add optional "go" and "fail" user coroutines.
3636
V0.16 Minor improvements and bugfixes. Eliminate `timeout` option which caused
3737
failures where `Responder` was a Pyboard.

v3/docs/TUTORIAL.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ print(uasyncio.__version__)
112112
```
113113
Version 3 will print a version number. Older versions will throw an exception.
114114

115-
###### [Main README](./README.md)
115+
###### [Main README](../README.md)
116116

117117
# 1. Cooperative scheduling
118118

0 commit comments

Comments
 (0)