bug-ncurses
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[PATCH 26/51] man/curs_ins{_w, }str.3x: Revise "RETURN VALUE" section.


From: G. Branden Robinson
Subject: [PATCH 26/51] man/curs_ins{_w, }str.3x: Revise "RETURN VALUE" section.
Date: Fri, 26 Jul 2024 12:50:52 -0500

Content:
* Drop X/Open Curses's lack of error condition specification from this
  section; it is (and is better) discussed in the "PORTABILITY" section.

Align style and markup of man/curs_insstr.3x with man/curs_ins_wstr.3x.
---
 man/curs_ins_wstr.3x |  1 -
 man/curs_insstr.3x   | 23 +++++++++++++++++------
 2 files changed, 17 insertions(+), 7 deletions(-)

diff --git a/man/curs_ins_wstr.3x b/man/curs_ins_wstr.3x
index eb179b22a..e67fb5ce1 100644
--- a/man/curs_ins_wstr.3x
+++ b/man/curs_ins_wstr.3x
@@ -111,7 +111,6 @@ .SH RETURN VALUE
 .B ERR
 on failure.
 .PP
-X/Open Curses does not specify any error conditions.
 In
 .IR \%ncurses ","
 they return
diff --git a/man/curs_insstr.3x b/man/curs_insstr.3x
index 0adc85439..34a9fea76 100644
--- a/man/curs_insstr.3x
+++ b/man/curs_insstr.3x
@@ -105,17 +105,28 @@ .SH DESCRIPTION
 .BR \-1 "."
 \fB\%ncurses\fP(3X) describes the variants of these functions.
 .SH RETURN VALUE
-All functions return the integer \fBERR\fP upon failure and \fBOK\fP on 
success.
+These functions return
+.B OK
+on success and
+.B ERR
+on failure.
 .PP
-X/Open Curses does not specify any error conditions.
-This implementation returns
+In
+.IR \%ncurses ","
+they return
 .B ERR
+if
 .bP
-if the \fIwin\fP parameter is null or
+.I win
+is
+.BR NULL ","
 .bP
-if the \fIstr\fP parameter is null or
+.I str
+is
+.BR NULL ","
+or
 .bP
-the \fBwinsch\fP(3X) function returns
+an internal \fBwinsch\fP(3X) call returns
 .BR ERR "."
 .PP
 Functions prefixed with \*(``mv\*('' first perform cursor movement and
-- 
2.30.2

Attachment: signature.asc
Description: PGP signature


reply via email to

[Prev in Thread] Current Thread [Next in Thread]