From 651ef067a5383f085b59ce61847e51ead4e40b2a Mon Sep 17 00:00:00 2001
From: Julian Gilbey <julian-git@d-and-j.net>
Date: Mon, 2 Sep 2024 01:22:43 +0100
Subject: [PATCH] Fix docstrings and markdown files so sphinx successfully
 compiles (#183)

Co-authored-by: Julian Gilbey <jdg@debian.org>
---
 CONTRIBUTING.md         | 16 +++++++++-------
 README.md               |  5 +++--
 aioitertools/asyncio.py |  2 +-
 3 files changed, 13 insertions(+), 10 deletions(-)

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 <path/to/aioitertools>
-    $ make venv
-    $ source .venv/bin/activate
-
+```sh
+$ cd <path/to/aioitertools>
+$ 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.
     """