From 9b73eda9576a846dc6c5e6c0ac14ed38e7b5b5ce Mon Sep 17 00:00:00 2001
From: pseudometa <73286100+chrisgrieser@users.noreply.github.com>
Date: Sat, 2 Sep 2023 09:52:40 +0200
Subject: [PATCH] docs: add global `--help` alias limitations

---
 README.md | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index d5116fd2..bb150097 100644
--- a/README.md
+++ b/README.md
@@ -228,15 +228,17 @@ help() {
 
 Then you can do `$ help cp` or `$ help git commit`.
 
-Alternatively, you can also use global aliases to override `-h` and `--help` entirely:
+When you are using `zsh`, you can also use global aliases to override `-h` and `--help` entirely:
 
 ```bash
-alias -g -- -h='-h | bat --language=help --style=plain'
-alias -g -- --help='--help | bat --language=help --style=plain'
+alias -g -- -h='-h 2>&1 | bat --language=help --style=plain'
+alias -g -- --help='--help 2>&1 | bat --language=help --style=plain'
 ```
 
 This way, you can keep on using `cp --help`, but get colorized help pages.
 
+Be aware that in some cases, `-h` may not be a shorthand of `--help` (for example with `ls`).
+
 Please report any issues with the help syntax in [this repository](https://github.com/victor-gp/cmd-help-sublime-syntax).