From 2130263b53febd073c44fdb9336227606b498753 Mon Sep 17 00:00:00 2001
From: Aaron LI <aly@aaronly.me>
Date: Wed, 29 Nov 2017 10:21:55 +0800
Subject: zsh/prompt: explain more about gitpwd()

---
 _zsh/30-prompt.zsh | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

(limited to '_zsh')

diff --git a/_zsh/30-prompt.zsh b/_zsh/30-prompt.zsh
index bd821d1..a4b5323 100644
--- a/_zsh/30-prompt.zsh
+++ b/_zsh/30-prompt.zsh
@@ -5,7 +5,10 @@
 #
 
 
-# gitpwd - print %~, limited to $NDIR segments, with inline git branch
+# gitpwd - format the current path with inline git branch for the
+#          prompt; the current path is limited to $NDIR segments,
+#          meanwhile long segments are shortened to be
+#          '<prefix>…<suffix>'.
 NDIRS=3
 function gitpwd() {
     local -a segs splitprefix
-- 
cgit v1.2.2