gbranden pushed a commit to branch master
in repository groff.
commit ea8dff2b56515218f21bb59599ab862074645f76
Author: G. Branden Robinson <[email protected]>
AuthorDate: Mon Jul 20 22:16:58 2026 -0500
[doc,man]: Update and sync footnote précis.
Fix an unclear pronoun antecedent and other issues.
---
doc/groff.texi.in | 19 ++++++++++---------
man/roff.7.man | 17 +++++++++--------
2 files changed, 19 insertions(+), 17 deletions(-)
diff --git a/doc/groff.texi.in b/doc/groff.texi.in
index 1cccbe211..d5e6e62b9 100644
--- a/doc/groff.texi.in
+++ b/doc/groff.texi.in
@@ -19583,20 +19583,21 @@ Footnote support often exercises all three of the
foregoing features.
A simple implementation might work as follows.
The author writes a pair of macros:@:
one starts a footnote and the other ends it.
-They further set a trap a small distance above the page bottom,
+The author also sets a trap a small distance above the page bottom,
reserving a footnote area.
-The author calls the first macro where a footnote mark is desired.
-The macro establishes a diversion so that the footnote text is collected
+The document calls the first macro where a footnote mark is desired.
+This macro establishes a diversion
+so that the footnote text is collected
at the place in the body text where its corresponding mark appears.
-It further creates an environment for the footnote so that it
-sets using a smaller typeface.
-The footnote text is formatted in the diversion using that environment
+It further creates and selects an environment for the footnote
+so that it sets using a smaller type size and vertical spacing.
+Diverting the text formats it,
but it does not yet appear in the output.
-The document author calls the footnote end macro,
+The document calls the footnote end macro,
which returns to the previous environment and ends the diversion.
Later,
-after body
-text nearly fills the page, the trap springs.
+after body text nearly fills the page,
+the trap springs.
The macro called by the trap draws a line across the page
and emits the stored diversion by calling it like a macro.
Thus,
diff --git a/man/roff.7.man b/man/roff.7.man
index 52012a911..abbf7a601 100644
--- a/man/roff.7.man
+++ b/man/roff.7.man
@@ -909,21 +909,22 @@ A simple implementation might work as follows.
The author writes a pair of macros:
one starts a footnote and the other ends it.
.
-They further set a trap a small distance above the page bottom,
+The author also sets a trap a small distance above the page bottom,
reserving a footnote area.
.
-The author calls the first macro where a footnote mark is desired.
+The document calls the first macro where a footnote mark is desired.
.
-The macro establishes a diversion so that the footnote text is collected
+This macro establishes a diversion
+so that the footnote text is collected
at the place in the body text where its corresponding mark appears.
.
-It further creates an environment for the footnote so that it sets
-at a smaller typeface.
+It further creates and selects an environment for the footnote
+so that it sets using a smaller type size and vertical spacing.
.
-The footnote text is formatted in the diversion using that environment,
+Diverting the text formats it,
but it does not yet appear in the output.
.
-The document author calls the footnote end macro,
+The document calls the footnote end macro,
which returns to the previous environment and ends the diversion.
.
Later,
@@ -934,7 +935,7 @@ The macro called by the trap draws a line across the page
and emits the stored diversion by calling it like a macro.
.
Thus,
-the footnote is rendered.
+the footnote renders.
.\" END Keep roughly parallel with first paragraphs of groff.texi node
.\" "Deferring Output".
.
_______________________________________________
groff-commit mailing list
[email protected]
https://lists.gnu.org/mailman/listinfo/groff-commit
