From bc1b7b971999f1dcb4d62eb149bafc703626dc68 Mon Sep 17 00:00:00 2001
From: Tom Ryder <tom@sanctum.geek.nz>
Date: Tue, 9 Jul 2019 14:43:18 +1200
Subject: Explain a parameter to a command function

---
 vim/vimrc | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/vim/vimrc b/vim/vimrc
index 48057f7b..c3f21c03 100644
--- a/vim/vimrc
+++ b/vim/vimrc
@@ -107,7 +107,8 @@ endif
 " We need a command to reliably establish a full path, whether or not the
 " directories already exist.  We create a wrapper for the autoloaded function
 " path#Create() with similar calling conventions to mkdir(), but with the ‘p’
-" value for the second parameter {prot} forced on.
+" value for the second parameter {prot} forced on.  Calling it with a bang
+" like :CreatePath! creates a private directory (permissions 0700).
 "
 command! -bang -bar -complete=dir -nargs=1 CreatePath
       \ call path#Create(expand(<q-args>), <q-bang> ==# '!')
-- 
cgit v1.2.3