better docstring for dirs.UnExpand

2024-07-27 16:30:28 -07:00 · 2024-07-27 16:30:28 -07:00 · a5e0a2546c
parent b3f19bef73
commit a5e0a2546c
1 changed files with 3 additions and 1 deletions
--- 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 != "" {