updated help.txt

70 views
Skip to first unread message

Christian Brabandt

unread,
Aug 4, 2022, 5:51:15 AM8/4/22
to vim...@vim.org
Hi,
a recent question on vi.stackexchange.com made me realize, that there is
no easy way to discover the help syntax being used. So I'd suggest to
add the following line to help.txt to make this a bit more easier
discoverable:

diff --git a/runtime/doc/help.txt b/runtime/doc/help.txt
index 361587536..1ab87af5e 100644
--- a/runtime/doc/help.txt
+++ b/runtime/doc/help.txt
@@ -26,6 +26,7 @@ Get specific help: It is possible to go directly to whatever you want help
Option ' :help 'textwidth'
Regular expression / :help /[
See |help-summary| for more contexts and an explanation.
+ See |notation| for the help syntax explained.

Search for help: Type ":help word", then hit CTRL-D to see matching
help entries for "word".


Thanks,
Christian
--
Die Kunst ist zwar nicht das Brot, aber der Wein des Lebens.
-- Jean Paul (eig. Johann Paul Friedrich Richter)

Bram Moolenaar

unread,
Aug 4, 2022, 8:02:18 AM8/4/22
to vim...@googlegroups.com, Christian Brabandt, vim...@vim.org

Christian wrote:

> a recent question on vi.stackexchange.com made me realize, that there is
> no easy way to discover the help syntax being used. So I'd suggest to
> add the following line to help.txt to make this a bit more easier
> discoverable:
>
> diff --git a/runtime/doc/help.txt b/runtime/doc/help.txt
> index 361587536..1ab87af5e 100644
> --- a/runtime/doc/help.txt
> +++ b/runtime/doc/help.txt
> @@ -26,6 +26,7 @@ Get specific help: It is possible to go directly to whatever you want help
> Option ' :help 'textwidth'
> Regular expression / :help /[
> See |help-summary| for more contexts and an explanation.
> + See |notation| for the help syntax explained.
>
> Search for help: Type ":help word", then hit CTRL-D to see matching
> help entries for "word".

I can add that. I think the sentence reads easier like this:

See |notation| for an explanation of the help syntax.

--
You can tune a file system, but you can't tuna fish
-- man tunefs

/// Bram Moolenaar -- Br...@Moolenaar.net -- http://www.Moolenaar.net \\\
/// \\\
\\\ sponsor Vim, vote for features -- http://www.Vim.org/sponsor/ ///
\\\ help me help AIDS victims -- http://ICCF-Holland.org ///
Reply all
Reply to author
Forward
0 new messages