diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index eb73ccf..58030a9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 - $ make venv - $ source .venv/bin/activate - +```sh +$ cd +$ make venv +$ source .venv/bin/activate +``` ## Submitting diff --git a/README.md b/README.md index 879a853..533887d 100644 --- a/README.md +++ b/README.md @@ -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 ----- diff --git a/aioitertools/asyncio.py b/aioitertools/asyncio.py index fa95a71..6ca4649 100644 --- a/aioitertools/asyncio.py +++ b/aioitertools/asyncio.py @@ -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. """