[vim-doc-es] possible corrections to vim documentation

From: Javier Rojas <jerojasro@xxxxxxxxxx>
To: bugs@xxxxxxx
Date: Wed, 2 Feb 2011 21:30:16 -0500

Hi,

I found several places in usr_41.txt (Vim User Manual) where I think
some changes would be useful:

  * Improper name for grouping characters. Patch: usr41.parentheses.diff
  * Correction of a label in a vimscript example. Patch:
    usr41.argname.diff
  * Improper abbreviation of "whitespace". Patch: usr41.white.diff
  * Unneeded use of "instead". Patch: usr41.instead2.diff
  * Missing colon in a sentence. Patch: usr41.missingcolon.diff

I'm not implying that the modifications I propose are correct; I'm not a
native English speaker, and I'd be very grateful if you could check
them, see if they are correct, and apply them if such is the case.

I created these patches against the fcea35e2a41f revision in the
Mercurial repository (this was the tip on February 2), using "hg
export".  All the patches are one-liners, but I made them that way
because they are all unrelated changes.

Thank you for your work,

-- 
Javier Rojas

GPG Key ID: 0x24E00D68

# HG changeset patch
# User Javier Rojas <jerojasro@xxxxxxxxxx>
# Date 1296699717 18000
# Node ID dc129a1c1ac1344160f397b254ef84bc3284bf5b
# Parent  fcea35e2a41fdc928cb92784a4405b4fd220f560
[mq]: usr41.parentheses

diff -r fcea35e2a41f -r dc129a1c1ac1 runtime/doc/usr_41.txt
--- a/runtime/doc/usr_41.txt    Tue Feb 01 21:55:01 2011 +0100
+++ b/runtime/doc/usr_41.txt    Wed Feb 02 21:21:57 2011 -0500
@@ -313,7 +313,7 @@
        :echo 10 + 5 * 2
 <      20 ~
 
-Grouping is done with braces.  No surprises here.  Example: >
+Grouping is done with parentheses.  No surprises here.  Example: >
 
        :echo (10 + 5) * 2
 <      30 ~

# HG changeset patch
# User Javier Rojas <jerojasro@xxxxxxxxxx>
# Date 1296698698 18000
# Node ID a58ed3a33b70c172d33dcda318d3056af28865ab
# Parent  fcea35e2a41fdc928cb92784a4405b4fd220f560
[mq]: usr41.missingcolon

diff -r fcea35e2a41f -r a58ed3a33b70 runtime/doc/usr_41.txt
--- a/runtime/doc/usr_41.txt    Tue Feb 01 21:55:01 2011 +0100
+++ b/runtime/doc/usr_41.txt    Wed Feb 02 21:04:58 2011 -0500
@@ -1479,7 +1479,7 @@
 
        :set tags=my\ nice\ file
 
-The same example written as >
+The same example written as: >
 
        :set tags=my nice file

# HG changeset patch
# User Javier Rojas <jerojasro@xxxxxxxxxx>
# Date 1296698317 18000
# Node ID 1b69b54a4d0568ea85ffc739cc72cad830c8537e
# Parent  fcea35e2a41fdc928cb92784a4405b4fd220f560
[mq]: usr41.instead2

diff -r fcea35e2a41f -r 1b69b54a4d05 runtime/doc/usr_41.txt
--- a/runtime/doc/usr_41.txt    Tue Feb 01 21:55:01 2011 +0100
+++ b/runtime/doc/usr_41.txt    Wed Feb 02 20:58:37 2011 -0500
@@ -1402,7 +1402,7 @@
 
 The ":read" command will fail if the file does not exist.  Instead of
 generating an error message, this code catches the error and gives the user a
-nice message instead.
+nice message.
 
 For the commands in between ":try" and ":endtry" errors are turned into
 exceptions.  An exception is a string.  In the case of an error the string

# HG changeset patch
# User Javier Rojas <jerojasro@xxxxxxxxxx>
# Date 1296697549 18000
# Node ID 4c78dc556ebbeef3dcf8c3d861e907b398c7c06f
# Parent  fcea35e2a41fdc928cb92784a4405b4fd220f560
[mq]: usr41.white

diff -r fcea35e2a41f -r 4c78dc556ebb runtime/doc/usr_41.txt
--- a/runtime/doc/usr_41.txt    Tue Feb 01 21:55:01 2011 +0100
+++ b/runtime/doc/usr_41.txt    Wed Feb 02 20:45:49 2011 -0500
@@ -1285,7 +1285,7 @@
 
        split(a:line)
 
-The split() function takes a string, chops it into white separated words
+The split() function takes a string, chops it into whitespace separated words
 and returns a list with these words.  Thus in the example it returns: >
 
        :echo split('three two five one')

# HG changeset patch
# User Javier Rojas <jerojasro@xxxxxxxxxx>
# Date 1296696606 18000
# Node ID 2f29921adf3e757f27b019ff653dc780a9947c45
# Parent  fcea35e2a41fdc928cb92784a4405b4fd220f560
imported patch usr41.argname

diff -r fcea35e2a41f -r 2f29921adf3e runtime/doc/usr_41.txt
--- a/runtime/doc/usr_41.txt    Tue Feb 01 21:55:01 2011 +0100
+++ b/runtime/doc/usr_41.txt    Wed Feb 02 20:30:06 2011 -0500
@@ -1017,7 +1017,7 @@
 
        :function Show(start, ...)
        :  echohl Title
-       :  echo "Show is " . a:start
+       :  echo "start is " . a:start
        :  echohl None
        :  let index = 1
        :  while index <= a:0

[vim-doc-es] possible corrections to vim documentation

Other related posts: