Skip to content

Commit 651ef06

Browse files
juliangilbeyJulian Gilbey
and
Julian Gilbey
authored
Fix docstrings and markdown files so sphinx successfully compiles (#183)
Co-authored-by: Julian Gilbey <[email protected]>
1 parent 37b44c2 commit 651ef06

File tree

3 files changed

+13
-10
lines changed

3 files changed

+13
-10
lines changed

CONTRIBUTING.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,21 @@
55
You'll need to have Python 3.8 or newer available for testing.
66
I recommend using [pyenv][] for this:
77

8-
$ pyenv install 3.12
9-
$ pyenv shell 3.12
10-
8+
```sh
9+
$ pyenv install 3.12
10+
$ pyenv shell 3.12
11+
```
1112

1213
## Setup
1314

1415
Create a fresh development enviroment, and install the
1516
appropriate tools and dependencies:
1617

17-
$ cd <path/to/aioitertools>
18-
$ make venv
19-
$ source .venv/bin/activate
20-
18+
```sh
19+
$ cd <path/to/aioitertools>
20+
$ make venv
21+
$ source .venv/bin/activate
22+
```
2123

2224
## Submitting
2325

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,9 @@ Install
1515
aioitertools requires Python 3.8 or newer.
1616
You can install it from PyPI:
1717

18-
$ pip install aioitertools
19-
18+
```sh
19+
$ pip install aioitertools
20+
```
2021

2122
Usage
2223
-----

aioitertools/asyncio.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -253,7 +253,7 @@ async def gather_iter(
253253
limit: int = -1,
254254
) -> List[T]:
255255
"""
256-
Wrapper around gather to handle gathering an iterable instead of *args.
256+
Wrapper around gather to handle gathering an iterable instead of ``*args``.
257257
258258
Note that the iterable values don't have to be awaitable.
259259
"""

0 commit comments

Comments
 (0)