[PATCH v2 11/18] man/define_key.3x: Clarify.

[G. Branden Robinson]

* Refer to function arguments by their metasyntactic variable names
  instead of their data types.
* Clarify return value; _either_ the keycode must be nonnegative, _or_
  the definition must be a non-null pointer to char.
---
 man/define_key.3x | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

diff --git a/man/define_key.3x b/man/define_key.3x
index b13a5fc7..d9a0d7c2 100644
--- a/man/define_key.3x
+++ b/man/define_key.3x
@@ -44,12 +44,13 @@ .SH DESCRIPTION
 strings, so that the \fIncurses\fP library will interpret them just as it would
 the predefined codes in the terminfo database.
 .PP
-If the given string is null, any existing definition for the keycode is
-removed.
+If \fIdefinition\fP is \fBNULL\fP,
+any existing one for the keycode is removed.
 Similarly, if the given keycode is negative or zero, any existing string
 for the given definition is removed.
 .SH RETURN VALUE
-The keycode must be greater than zero, and the string non-null,
+Either \fIkeycode\fP must be greater than zero,
+or \fIdefinition\fP must be non-\fBNULL\fP,
 otherwise \fBERR\fP is returned.
 \fBERR\fP may also be returned if there is insufficient memory to allocate the
 data to store the definition.
-- 
2.30.2

signature.asc
Description: PGP signature