Fix docstrings and markdown files so sphinx successfully compiles (#183)
Co-authored-by: Julian Gilbey <jdg@debian.org>
This commit is contained in:
parent
37b44c28a3
commit
651ef067a5
|
@ -5,19 +5,21 @@
|
|||
You'll need to have Python 3.8 or newer available for testing.
|
||||
I recommend using [pyenv][] for this:
|
||||
|
||||
$ pyenv install 3.12
|
||||
$ pyenv shell 3.12
|
||||
|
||||
```sh
|
||||
$ pyenv install 3.12
|
||||
$ pyenv shell 3.12
|
||||
```
|
||||
|
||||
## Setup
|
||||
|
||||
Create a fresh development enviroment, and install the
|
||||
appropriate tools and dependencies:
|
||||
|
||||
$ cd <path/to/aioitertools>
|
||||
$ make venv
|
||||
$ source .venv/bin/activate
|
||||
|
||||
```sh
|
||||
$ cd <path/to/aioitertools>
|
||||
$ make venv
|
||||
$ source .venv/bin/activate
|
||||
```
|
||||
|
||||
## Submitting
|
||||
|
||||
|
|
|
@ -15,8 +15,9 @@ Install
|
|||
aioitertools requires Python 3.8 or newer.
|
||||
You can install it from PyPI:
|
||||
|
||||
$ pip install aioitertools
|
||||
|
||||
```sh
|
||||
$ pip install aioitertools
|
||||
```
|
||||
|
||||
Usage
|
||||
-----
|
||||
|
|
|
@ -253,7 +253,7 @@ async def gather_iter(
|
|||
limit: int = -1,
|
||||
) -> List[T]:
|
||||
"""
|
||||
Wrapper around gather to handle gathering an iterable instead of *args.
|
||||
Wrapper around gather to handle gathering an iterable instead of ``*args``.
|
||||
|
||||
Note that the iterable values don't have to be awaitable.
|
||||
"""
|
||||
|
|
Loading…
Reference in New Issue