git: 47b7701125 - main - fdp-primer/writing-style: Fix section level
Lorenzo Salvadore <[email protected]>
| Newsgroups | gmane.os.freebsd.devel.cvs.doc |
|---|---|
| Message-ID | <[email protected]> |
The branch main has been updated by salvadore: URL: https://cgit.FreeBSD.org/doc/commit/?id=47b7701125a7ef4157cfa9e8318d61b6663175bb commit 47b7701125a7ef4157cfa9e8318d61b6663175bb Author: Lorenzo Salvadore <[email protected]> AuthorDate: 2023-04-23 09:06:59 +0000 Commit: Lorenzo Salvadore <[email protected]> CommitDate: 2023-04-23 09:29:38 +0000 fdp-primer/writing-style: Fix section level Acronyms are not a subtopic of the one sentence per line technique, so it does not make sense to have them in a subsection of the "One sentence per line" section. --- documentation/content/en/books/fdp-primer/writing-style/_index.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/content/en/books/fdp-primer/writing-style/_index.adoc b/documentation/content/en/books/fdp-primer/writing-style/_index.adoc index f5b6904c1e..6fb569e607 100644 --- a/documentation/content/en/books/fdp-primer/writing-style/_index.adoc +++ b/documentation/content/en/books/fdp-primer/writing-style/_index.adoc @@ -193,7 +193,7 @@ They are endowed with reason and conscience and should act towards one another i .... [[writing-style-acronyms]] -=== Acronyms +== Acronyms Acronyms should be defined the first time they appear in a document, as in: "Network Time Protocol (NTP)". After the acronym has been defined, use the acronym alone unless it makes more sense contextually to use the whole term.