Actualize documentation
authorSergey Matveev <stargrave@stargrave.org>
Wed, 27 May 2020 20:38:24 +0000 (23:38 +0300)
committerSergey Matveev <stargrave@stargrave.org>
Wed, 27 May 2020 20:38:24 +0000 (23:38 +0300)
doc/codecomm.txt

index 0156332533c5e2592c25ba40c89b08aa8c5a6207..0885e6b4e2dd912285718ae0ab4e92bb4605f008 100644 (file)
@@ -9,23 +9,25 @@ code there? This plugin helps you to do that.
 CONFIGURATION                                           *codecomm-config*
 
 The only option for the Vim plugin is the placement of temporary file
-with aggregated comments. By default it is /tmp/codecomm.txt. You can
-override it in your .vimrc: >
+with aggregated comments. By default it is /tmp/codecomm.txt.
+You can override /tmp with $TMPDIR environment variable and the whole
+file path with: >
     let g:codecomm_file = "/another/path.txt"
 
 PLUGIN USAGE                                             *codecomm-usage*
 
-* Open necessary commit using Fugitive (:Gedit) and file inside it
+* Open necessary commit using Fugitive (:Gedit) and file inside it.
+  If you won't use Fugitive, then commit hash won't be set in the
+  message, but everything should work the same way anyway
 * Visually select a bunch of code lines you want to comment
-* Press <Leader>cc (usually "\cc") or call :CodeComm command
-  specifying the range
-* You will see an additional window with your code
+* Press <Leader>cc or call :{range}CodeComm command
+* You will see an additional window with your selection
 * Add necessary comment message below ----- >8 ----- line
-* Either press <CR> in normal mode, or save buffer and exit
+* Save buffer and exit
 * Comment window will be closed, saving your consolidated changes
-  in temporary file
-* To wipe out all your comments either call :CodeCommClear or remove
-  that temporary file)
+  in g:codecomm_file
+* To wipe out all your comments you can call :CodeCommClear
+* To edit comments you can call :CodeCommEdit
 
 CODECOMM FILE FORMAT                                     *codecomm-format*
 >
@@ -40,9 +42,9 @@ CODECOMM FILE FORMAT                                     *codecomm-format*
     ---------------------------------- >8 ----------------------------------
     Here goes my comment.
 
-Header line contains:
+Header contains:
 
-* Comment's serial number (#2 in example above)
+* Comment's number (#2 in example above)
 * Optional commit's hash (ec77b1f6b)
 * Full path to commented file inside repository