summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authortjex <tjex@tjex.net>2023-11-04 21:03:10 +0100
committerDenis Isidoro <denis.isidoro@uber.com>2023-12-10 06:26:34 -0300
commitbe8326df6b6910880f96751b82224daa7ec03a99 (patch)
tree769dcd341042b78acfeaae1237caacaa0f842746
parent449141a9d57d930e308eb9df978e9ba5f85ec812 (diff)
docs: extra clarity
-rw-r--r--docs/paths_and_environment_variables.md5
1 files changed, 4 insertions, 1 deletions
diff --git a/docs/paths_and_environment_variables.md b/docs/paths_and_environment_variables.md
index 99eb490..f0cdbb9 100644
--- a/docs/paths_and_environment_variables.md
+++ b/docs/paths_and_environment_variables.md
@@ -12,7 +12,7 @@ environment variables:
export NAVI_CONFIG="~/.config/navi/config.yaml"
export NAVI_PATH="~/.local/share/navi"
```
-Note! Even when set, `$NAVI_PATH` will not be used when installing cheat
+Despite `$NAVI_PATH` being set, it will not be used when installing cheat
sheets directly via navi's own commands.
For example when running `navi add repo <repo>`, the default paths as per the `directories-next`
@@ -20,3 +20,6 @@ package will still be used.
To avoid this, you may simply clone repos via a regular `git clone` command,
directly into `$NAVI_PATH`.
+
+Note! `navi info cheats-path` and `navi info config-path` display the *default* path, not
+the path set by the user. [It is known that this is a little misleading!](https://github.com/denisidoro/navi/issues/664#issuecomment-1004721178).