commit d9ea07515ba9d359ce4c293b971f8d36a585034b
parent de829208193936b2b1d266fe144a8eeff98a5565
Author: Benno Schulenberg <bensberg@telfort.nl>
Date: Sun, 20 Oct 2024 13:15:56 +0200
docs: clarify the possible effects of a misuse of braced function names
And fix a nearby grammatical mistake that was
caused by commit 77a8841d from four months ago.
Inspired-by: Max Gammache <bigjango13@gmail.com>
Diffstat:
2 files changed, 5 insertions(+), 4 deletions(-)
diff --git a/doc/nano.texi b/doc/nano.texi
@@ -1441,12 +1441,13 @@ Unbinds @code{key} from @code{menu}
Note that @code{bind key "@{function@}" menu} is equivalent to
@code{bind key function menu}, except that for the latter form
@command{nano} checks the availability of the @code{function}
-in the given @code{menu} at startup time (and report an error if
+in the given @code{menu} at startup time (and reports an error if
it does not exist there), whereas for the first form @command{nano}
checks at execution time that the @code{function} exists but not
whether it makes any sense in the current menu. The user has to take
care that a function name between braces (or any sequence of them)
-is appropriate. Strange behavior can result when it is not.
+is appropriate. Strange behavior or even a crash can result when
+the braced name is unfitting.
@sp 1
The format of @code{key} should be one of:
diff --git a/doc/nanorc.5 b/doc/nanorc.5
@@ -600,11 +600,11 @@ menus where the key exists when \fBall\fP is used).
Note that \fBbind \fIkey\fR \fB"{\fIfunction\fB}"\fR \fImenu\fR is equivalent
to \fBbind \fIkey\fR \fIfunction\fR \fImenu\fR, except that for the latter form
\fBnano\fR checks the availability of the \fIfunction\fR in the given \fImenu\fR
-at startup time (and report an error if it does not exist there), whereas for the
+at startup time (and reports an error if it does not exist there), whereas for the
first form \fBnano\fR checks at execution time that the \fIfunction\fR exists
but not whether it makes any sense in the current menu. The user has to take care
that a function name between braces (or any sequence of them) is appropriate.
-Strange behavior can result when it is not.
+Strange behavior or even a crash can result when the braced name is unfitting.
.TP
The format of \fIkey\fP should be one of:
