Date: Sun, 23 Apr 2023 09:31:08 +0000 From: Lorenzo Salvadore <developer@lorenzosalvadore.it> To: Lorenzo Salvadore <salvadore@FreeBSD.org> Cc: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org Subject: Re: git: 47b7701125 - main - fdp-primer/writing-style: Fix section level Message-ID: <oS_Fc1pZYtbkHhOpCA3Baa7O8Y-WsB9zxVewAgp63V09neWk7WAxlwX9iJRJqiEuFMDIjeizndWc-lw8F3TNTv0misZy4tYDbnhIap_eOQc=@lorenzosalvadore.it> In-Reply-To: <202304230930.33N9U0KK087402@gitrepo.freebsd.org> References: <202304230930.33N9U0KK087402@gitrepo.freebsd.org>
next in thread | previous in thread | raw e-mail | index | archive | help
------- Original Message ------- On Sunday, April 23rd, 2023 at 11:30 AM, Lorenzo Salvadore <salvadore@FreeBSD.org> wrote: > > > The branch main has been updated by salvadore: > > URL: https://cgit.FreeBSD.org/doc/commit/?id=47b7701125a7ef4157cfa9e8318d61b6663175bb > > commit 47b7701125a7ef4157cfa9e8318d61b6663175bb > Author: Lorenzo Salvadore salvadore@FreeBSD.org > > AuthorDate: 2023-04-23 09:06:59 +0000 > Commit: Lorenzo Salvadore salvadore@FreeBSD.org > > 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. Approved by: doceng (blanket) > --- > 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.
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?oS_Fc1pZYtbkHhOpCA3Baa7O8Y-WsB9zxVewAgp63V09neWk7WAxlwX9iJRJqiEuFMDIjeizndWc-lw8F3TNTv0misZy4tYDbnhIap_eOQc=>