bug-ncurses
[Top][All Lists]
Advanced

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

[PATCH 17/17] Fix style nits around "datatype".


From: G. Branden Robinson
Subject: [PATCH 17/17] Fix style nits around "datatype".
Date: Fri, 13 Oct 2023 18:42:23 -0500

Say "data type" instead of "datatype".

Fix adjacent style problems.
- Set data type literals in italics, not bold.
- Set "ncurses" in italics.
- Protect literals (and "ncurses") from hyphenation.
- Recast for economy.

- Use "that" with restrictive clauses, not "which".  This problem is
  _ubiquitous_ in the ncurses man pages, a veritably perfervid solecism.

  https://www.grammarly.com/blog/which-vs-that/

  (Can I get change for my ten-dollar words?)

- Unhyphenate noun phrases.  Generally, phrases that are not used
  attributively do not require hyphenation, apart from certain frozen
  occurrences like "mother-of-pearl" or "attorney-at-law".  Thus, we
  would say, "provide a function for field validation" and
  "field-validating functions".  I would not say "field-validation
  functions", even though it follows the rule, because an even clearer
  expression using the gerund "validating" is available.  These rules
  exist to avoid the "bright red dog" problem.  When we say that, do we
  mean that the dog is bright red, or that the dog is red and also
  bright (that is, intelligent)?  Saying "bright-red dog" is clearer.
  But we should not overapply the rule and, nonstandardly, use hyphens
  as a general indicator of precedence for lexical binding in English.
---
 man/curs_attr.3x      | 12 ++++++------
 man/form_variables.3x |  4 ++--
 man/ncurses.3x        |  6 +++---
 3 files changed, 11 insertions(+), 11 deletions(-)

diff --git a/man/curs_attr.3x b/man/curs_attr.3x
index 4ecf7163..5fd927b7 100644
--- a/man/curs_attr.3x
+++ b/man/curs_attr.3x
@@ -160,10 +160,10 @@ .SS Legacy window attributes
 These newer routines use similar names, because
 X/Open simply added an underscore (\fB_\fP) for the newer names.
 .PP
-The \fBint\fP datatype used in the legacy routines is treated as if
-it is the same size as \fBchtype\fP (used by \fBaddch\fP(3X)).
-It holds the common video attributes (such as bold, reverse),
-as well as a few bits for color.
+The \fIint\fP data type used in the legacy routines is treated as if
+it were the same size as \fI\%chtype\fP (used by \fB\%addch\fP(3X)).
+It holds attributes such as bold and inverse as well as a few bits for
+color.
 Those bits correspond to the \fBA_COLOR\fP symbol.
 The \fBCOLOR_PAIR\fP macro provides a value which can be OR'd into
 the attribute parameter.
@@ -532,8 +532,8 @@ .SH PORTABILITY
 For example, the Solaris \fIxpg4\fP (X/Open) curses declares
 \fBattr_t\fP to be an unsigned short integer (16-bits),
 while \fBchtype\fP is a unsigned integer (32-bits).
-The \fBWA_\fP symbols in this case are different from the \fBA_\fP symbols
-because they are used for a smaller datatype which does not
+The \fBWA_\fP symbols in this case differ from the \fBA_\fP symbols
+because they are used for a smaller data type that does not
 represent \fBA_CHARTEXT\fP or \fBA_COLOR\fP.
 .IP
 In this implementation (as in many others), the values happen to be
diff --git a/man/form_variables.3x b/man/form_variables.3x
index ad4d609f..fadba4cc 100644
--- a/man/form_variables.3x
+++ b/man/form_variables.3x
@@ -54,8 +54,8 @@ .SH DESCRIPTION
 These are building blocks for the form library,
 defining fields that can be created using
 the \fBform_fieldtype\fP(3X) functions.
-Each provides functions for field- and character-validation,
-according to the given datatype.
+Each provides functions for field and character validation,
+according to the given data type.
 .SS TYPE_ALNUM
 This holds alphanumeric data.
 .SS TYPE_ALPHA
diff --git a/man/ncurses.3x b/man/ncurses.3x
index 0d9c50fa..6c2066cd 100644
--- a/man/ncurses.3x
+++ b/man/ncurses.3x
@@ -1530,9 +1530,9 @@ .SS Header files
 Very old versions of AIX curses required including <curses.h>
 before including <term.h>.
 .IP
-Because ncurses header files include the headers needed to
-define datatypes used in the headers,
-ncurses header files can be included in any order.
+Because \fI\%ncurses\fP header files include any others needed to define
+the data types they use,
+\fI\%ncurses\fP header files can be included in any order.
 But for portability, you should include <curses.h> before <term.h>.
 .bP
 X/Open Curses says \fI"may make visible"\fP
-- 
2.30.2

Attachment: signature.asc
Description: PGP signature


reply via email to

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