Mention [recipes] extra in docs

alisaifee · Dec 6, 2024 · 2bba54c · 2bba54c
1 parent 5d2f776
commit 2bba54c
Showing 1 changed file with 8 additions and 2 deletions.
diff --git a/docs/source/recipes/index.rst b/docs/source/recipes/index.rst
@@ -1,12 +1,18 @@
 Recipes
 =======
 Collection of recipes & recommendations to use **coredis**
-for common application patterns. Some of these recipes are shipped as
+for common application patterns. These recipes are shipped as
 part of the library under the :mod:`coredis.recipes` namespace.
 
+Some of these recipes may require additional dependencies that
+are not installed by default with the :pypi:`coredis` package.
+To ensure all dependencies required by the recipes are installed,
+use the ``[recipes]`` extra::
+
+    pip install coredis[recipes]
 
 .. toctree::
-    :maxdepth: 3
+    :maxdepth: 2
 
     credentials
     locks