jq is required for zsh auto-completion

mstmob · Nov 3, 2022 · aa738c6 · aa738c6
1 parent 3e51b7e
commit aa738c6
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/docs/source/install.rst b/docs/source/install.rst
@@ -105,3 +105,7 @@ If your packages are generated using python wheels, this should not be an issue
 (much like it won't be an issue for users installing via ``pip``).
 
 .. _setup.py: https://github.com/pimutils/todoman/blob/main/setup.py
+
+Additionally, `jq` is dependency for zsh's autocompletion. For platforms where
+`zsh` is the default shell, it is recommended to list `jq` as a dependency, for
+others adding it as an optional dependency should suffice.