Monday, November 5, 2012

Re: 'opt' vs. |'opt'| in help files

Andre Majorel wrote:

> When an option is mentioned in the help files, sometimes, it's
> "'option'", sometimes "|'option'|". Since ^] works just as well
> on the former, what's the point of adding the "|" ? Is it just a
> leftover from a time when ^] required them ?

Yeah, this is not totally consistent. Both with and without | works.
I think it's best to omit the |, unless the tag is not part of the
sentence. That is sometimes used as a pointer to more information.

--
When a fly lands on the ceiling, does it do a half roll or
a half loop?

/// Bram Moolenaar -- Bram@Moolenaar.net -- 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_use" 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

No comments: