groff-commit
[Top][All Lists]
Advanced

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

[groff] 09/24: [docs]: Further clarify string applications.


From: G. Branden Robinson
Subject: [groff] 09/24: [docs]: Further clarify string applications.
Date: Tue, 27 Dec 2022 04:22:43 -0500 (EST)

gbranden pushed a commit to branch master
in repository groff.

commit a57142fabdaf658a4794cd96ebedd1e34cbe5004
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Sun Dec 25 16:12:19 2022 -0600

    [docs]: Further clarify string applications.
---
 doc/groff.texi  | 10 ++++++----
 man/groff.7.man |  9 ++++++---
 2 files changed, 12 insertions(+), 7 deletions(-)

diff --git a/doc/groff.texi b/doc/groff.texi
index cc09be896..9c8d6df99 100644
--- a/doc/groff.texi
+++ b/doc/groff.texi
@@ -12070,9 +12070,10 @@ is the default.
 @cindex strings
 
 GNU @code{troff} supports strings primarily for user convenience.
-Conventionally, if a macro definition needs only to interpolate text,
-without invoking any requests or calling any other macros, a string is
-defined instead.  Only one string is predefined by the language.
+Conventionally, if one would define a macro only to interpolate a small
+amount of text, without invoking requests or calling any other macros,
+one defines a string instead.  Only one string is predefined by the
+language.
 
 @Defstr {.T}
 @stindex .T
@@ -12190,7 +12191,8 @@ to allow embedding of leading spaces.
 @cindex escaping newline characters, in strings
 Strings are not limited to a single input line of text.
 @code{\@key{RET}} works just as it does elsewhere.  The resulting string
-is stored @emph{without} the newlines.
+is stored @emph{without} the newlines.  Care is therefore required when
+interpolating strings while filling is disabled.
 
 @Example
 .ds foo This string contains \
diff --git a/man/groff.7.man b/man/groff.7.man
index 076c0ec87..731aa4de7 100644
--- a/man/groff.7.man
+++ b/man/groff.7.man
@@ -5086,9 +5086,9 @@ then restore it.
 supports strings primarily for user convenience.
 .
 Conventionally,
-if a macro definition needs only to interpolate text,
-without invoking any requests or calling any other macros,
-a string is defined instead.
+if one would define a macro only to interpolate a small amount of text,
+without invoking requests or calling any other macros,
+one defines a string instead.
 .
 Only one string is predefined by the language.
 .
@@ -5173,6 +5173,9 @@ The resulting string is stored
 .I without
 the newlines.
 .
+Care is therefore required when interpolating strings while filling is
+disabled.
+.
 It is not possible to embed a newline in a string that will be
 interpreted as such when the string is interpolated.
 .



reply via email to

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