From 652489251b5e8eeefea0c339adf293e5f8341db7 Mon Sep 17 00:00:00 2001 From: Claw Explorer Date: Sat, 28 Mar 2026 16:34:28 -0400 Subject: [PATCH] docs: move removal instructions into a TIP callout Address review feedback from @keith-hall: wrap the abbreviation removal instructions in a GitHub callout (> [!TIP]) to visually separate them from the main setup flow. Also reorder so the 'This way, you can keep on using...' sentence follows directly after the abbreviation creation, improving readability. --- README.md | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 140c3022..d6ef3381 100644 --- a/README.md +++ b/README.md @@ -244,17 +244,16 @@ abbr -a --position anywhere -- --help '--help | bat -plhelp' abbr -a --position anywhere -- -h '-h | bat -plhelp' ``` -To remove these abbreviations later: - -```fish -abbr -e -- --help -abbr -e -- -h -``` - -The `--` before the abbreviation name is required because `--help` and `-h` start with dashes, which would otherwise be interpreted as flags to `abbr` itself. - This way, you can keep on using `cp --help`, but get colorized help pages. +> [!TIP] +> To remove these abbreviations later, run: +> ```fish +> abbr -e -- --help +> abbr -e -- -h +> ``` +> The `--` before the abbreviation name is required because `--help` and `-h` start with dashes, which would otherwise be interpreted as flags to `abbr` itself. + Be aware that in some cases, `-h` may not be a shorthand of `--help` (for example with `ls`). In cases where you need to use `-h` as a command argument you can prepend `\` to the argument (eg. `ls \-h`) to escape the aliasing defined above.