bug-ncurses
[Top][All Lists]
Advanced

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

[PATCH 30/51] man/curs_attr.3x: Recast "RETURN VALUE" section.


From: G. Branden Robinson
Subject: [PATCH 30/51] man/curs_attr.3x: Recast "RETURN VALUE" section.
Date: Fri, 26 Jul 2024 12:51:37 -0500

Style:
* Parallelize language with other recently revised ncurses man pages.
* Favor saying "ncurses" over "this implementation".
* Stop mixing the general with the specific when discussing error
  conditions.
* Set literals in bold, not roman.
* When typesetting, put a thin space between the two dots of a range
  indicator.

Markup:
* Favor man(7) font style macros over *roff font selection escape
  sequences, except for man page cross references (because
  man/make_sed.sh recognizes only certain patterns when rewriting such
  cross references) and terms in the "NAME" section (because the
  generated edit_man.sh script expects font selection escape sequences
  when scraping terms thence to gather names for man page aliases).
---
 man/curs_attr.3x | 40 ++++++++++++++++++++++++++++------------
 1 file changed, 28 insertions(+), 12 deletions(-)

diff --git a/man/curs_attr.3x b/man/curs_attr.3x
index 6ceed816d..afabf6f96 100644
--- a/man/curs_attr.3x
+++ b/man/curs_attr.3x
@@ -304,22 +304,38 @@ .SS "Video Attributes"
 The SVr4 manual page claims (falsely) that these routines always return 
\fB1\fP.
 .\" ---------------------------------------------------------------------------
 .SH RETURN VALUE
-All routines return the integer \fBOK\fP on success, or \fBERR\fP on failure.
-.PP
+These functions return
+.B OK
+on success and
+.B ERR
+on failure.
 .PP
-This implementation
-.bP
-returns
+In
+.IR \%ncurses ","
+they return
 .B ERR
-if the window pointer is null.
-.bP
+if
+.I win
+is
+.BR NULL "."
+.PP
+.B \%wcolor_set
 returns
 .B ERR
-if the color pair parameter
-for \fBwcolor_set\fP is outside the range 0..COLOR_PAIRS\-1.
-.bP
-does not fail if either of the parameters of \fBwattr_get\fP
-used for retrieving attribute or color pair values is \fBNULL\fP.
+if
+.I pair
+is outside the range
+.BR 0 .\|. COLOR_PAIRS\-1 .
+.PP
+.B \%wattr_get
+does
+.I not
+fail if its
+.I \%attrs
+or
+.I \%pair
+parameter is
+.BR NULL "."
 .PP
 Functions prefixed with \*(``mv\*('' first perform cursor movement and
 fail if the position
-- 
2.30.2

Attachment: signature.asc
Description: PGP signature


reply via email to

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