docs: clarify git icon positions (#2235)

2023-05-27 16:23:33 +10:00
parent 164eb10cbd
commit e2a4c9d09d
1 changed files with 9 additions and 9 deletions
--- a/doc/nvim-tree-lua.txt
+++ b/doc/nvim-tree-lua.txt
@@ -58,15 +58,15 @@ Colours

 Git Integration

-    Icon indicates when a file is:
-    - ✗  unstaged or folder is dirty
-    - ✓  staged
-    - ★  new file
-    - ✓ ✗ partially staged
-    - ✓ ★ new file staged
-    - ✓ ★ ✗ new file staged and has unstaged modifications
-    - ═  merging
-    - ➜  renamed
+    One or two icons for git status. When two are shown, the left is staged.
+
+      ✗  unstaged
+      ✓  staged
+        unmerged
+      ➜  renamed
+      ★  untracked
+        deleted
+      ◌  ignored

 Requirements