Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix docstrings and markdown files so sphinx successfully compiles #183

Merged
merged 1 commit into from
Sep 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 9 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----
Expand Down
2 changes: 1 addition & 1 deletion aioitertools/asyncio.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
"""
Expand Down
Loading