Stefan Parviainen wrote:
> I've run into a few bugs in the Vim documentation, most in index.txt
> because that is really the only place I've looked.
>
> - :view does not mention that it exits Ex mode in index.txt
> - This is mentioned in editing.txt but not in index.txt
> - Can someone explain why this is? Shouldn't it be like ":edit" but
> read-only?
Index.txt omits many details, that's intentional. :view is an old Vi
command, it works like it works ni Vi.
> - Old notation for some key codes is still used
> - e.g. in index.txt "<ESC>" is used instead of "<Esc>" in one place
Fixed.
> - It should be easy to grep through the documentation and replace
> old usage with new one
It's easy to make a mistake that way. Grepping is OK, but replacement
can only be done after verifying it's the right thing to do.
> - gQ is not mentioned at all in index.txt
I'll add it.
> - In index.txt the command "@" says "@{a-z}" but plenty of other
> register names are valid and the main documentation of this command in
> repeat.txt says "@{0-9a-z".=*}" which seems more correct.
index.txt omits many details.
> - The columns in index.txt are not properly aligned. There are several
> instances where one column contains data that is too long and it runs
> into the next column. Making the columns wider would solve this issue.
It has to stay under 80 columns. It's OK for normal reading.
I do have a problem with the aligning now that we conceal the ||. Not
easy to fix.
> Some issues which are more wishes then bugs:
> - Some columns in index.txt are separated by a single space. This
> makes it difficult to parse the column data since it is hard to say
> where one column ends and one begins.
The text is not written to be parsed but to be read by a human.
> - It seems to me that things enclosed in {} are often regular
> expression character class-like, except with {} instead of [].
> |quote| "{a-zA-Z0-9.%#:-"}
> Changing {} to [] does result in a valid regular expression character
> class in Vim's dialect, but it's not valid in some other
> implementations since :-" is interpreted as a character range, which
> is invalid. Moving the single dash which does not represent a range to
> be the last character fixes the issue.
These things are not regular expressions.
> - Ex commands do not indicate arguments
> - It would be nice to know which commands expect arguments
> (e.g. :s, :edit) and which don't (e.g. :quit)
Follow the tag. This short overview becomes less readable when adding
the arguments.
> - Ex commands do not indicate if they support ranges
> - It would be nice to know which commands can take ranges (e.g. :s)
> and which don't (e.g. :edit)
Same answer.
> The above changes would make it easier to parse the documentation
> automatically and check whether a given command is valid without
> having to actually enter it in Vim.
This documentation was not intended to be parsed and going that way
would make it less readable for humans.
--
If bankers can count, how come they have eight windows and
only four tellers?
/// Bram Moolenaar -- [email protected] -- http://www.Moolenaar.net \\\
/// sponsor Vim, vote for features -- http://www.Vim.org/sponsor/ \\\
\\\ an exciting new programming language -- http://www.Zimbu.org ///
\\\ help me help AIDS victims -- http://ICCF-Holland.org ///
--
You received this message from the "vim_dev" maillist.
Do not top-post! Type your reply below the text you are replying to.
For more information, visit http://www.vim.org/maillist.php
