From a5e0a2546c29a2654876c895f06094a4872a3d61 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Lilian=20J=C3=B3nsd=C3=B3ttir?=
 <lilian.jonsdottir@gmail.com>
Date: Sat, 27 Jul 2024 16:30:28 -0700
Subject: [PATCH] better docstring for dirs.UnExpand

---
 internal/dirs/dirs.go | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/internal/dirs/dirs.go b/internal/dirs/dirs.go
index b491774..426b388 100644
--- a/internal/dirs/dirs.go
+++ b/internal/dirs/dirs.go
@@ -13,10 +13,12 @@ var (
 	pwd, _        = os.Getwd()
 )
 
-// UnExpand unexpands some directory shortcuts
+// UnExpand returns dir after expanding some directory shortcuts
 //
 // $HOME -> ~
+//
 // $PWD -> .
+//
 // workdir -> /
 func UnExpand(dir, workdir string) (outdir string) {
 	if dir != "" {