From nobody Sun Apr 23 09:31:08 2023 X-Original-To: dev-commits-doc-all@mlmmj.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mlmmj.nyi.freebsd.org (Postfix) with ESMTP id 4Q43174Yvtz476yW for ; Sun, 23 Apr 2023 09:31:23 +0000 (UTC) (envelope-from developer@lorenzosalvadore.it) Received: from mail-4317.proton.ch (mail-4317.proton.ch [185.70.43.17]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "protonmail.com", Issuer "R3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4Q43172XHhz3Frm; Sun, 23 Apr 2023 09:31:23 +0000 (UTC) (envelope-from developer@lorenzosalvadore.it) Authentication-Results: mx1.freebsd.org; none Date: Sun, 23 Apr 2023 09:31:08 +0000 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=lorenzosalvadore.it; s=protonmail2; t=1682242280; x=1682501480; bh=xYfpIkxeFpnPhYnzn2fwg2mfk1C9G42sUyvZTw6+B+E=; h=Date:To:From:Cc:Subject:Message-ID:In-Reply-To:References: Feedback-ID:From:To:Cc:Date:Subject:Reply-To:Feedback-ID: Message-ID:BIMI-Selector; b=OJFzKD5rfmdUsqIhnlP+hrreYJAF0V88JUpZN4A9vQS+clQeWzwKqW+wRjLILmYqS D27Gixe7Ux1KaspIVDZGqaImIKLw2ghIIDKWufloPzn7pmb5mVGysQCGIz86Gcu1ee 2o/t082wyv7is+nA0TO5gMJiPIF+akTCyldKM7ZGPS4TN38hH93NBkfTbvFOclMUP4 4JWBGgAynpHpg5xUOJELR2PUK3nNDWhgtbZ2YgWzaSoPuxpfuWkPqneOYf4+Jt5/2p pXcl0fpTxflIT1vK2ksSRuAh/VH5VLqid2agNfGaI/29QzdWP8P7jzr7r44VTd9wu8 gmsDz9bpPYdRQ== To: Lorenzo Salvadore From: Lorenzo Salvadore 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: In-Reply-To: <202304230930.33N9U0KK087402@gitrepo.freebsd.org> References: <202304230930.33N9U0KK087402@gitrepo.freebsd.org> Feedback-ID: 53711648:user:proton List-Id: Commit messages for all branches of the doc repository List-Archive: https://lists.freebsd.org/archives/dev-commits-doc-all List-Help: List-Post: List-Subscribe: List-Unsubscribe: Sender: owner-dev-commits-doc-all@freebsd.org X-BeenThere: dev-commits-doc-all@freebsd.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable X-Rspamd-Queue-Id: 4Q43172XHhz3Frm X-Spamd-Bar: ---- X-Spamd-Result: default: False [-4.00 / 15.00]; REPLY(-4.00)[]; ASN(0.00)[asn:62371, ipnet:185.70.43.0/24, country:CH] X-Rspamd-Pre-Result: action=no action; module=replies; Message is reply to one we originated X-ThisMailContainsUnwantedMimeParts: N ------- Original Message ------- On Sunday, April 23rd, 2023 at 11:30 AM, Lorenzo Salvadore wrote: >=20 >=20 > The branch main has been updated by salvadore: >=20 > URL: https://cgit.FreeBSD.org/doc/commit/?id=3D47b7701125a7ef4157cfa9e831= 8d61b6663175bb >=20 > commit 47b7701125a7ef4157cfa9e8318d61b6663175bb > Author: Lorenzo Salvadore salvadore@FreeBSD.org >=20 > AuthorDate: 2023-04-23 09:06:59 +0000 > Commit: Lorenzo Salvadore salvadore@FreeBSD.org >=20 > CommitDate: 2023-04-23 09:29:38 +0000 >=20 > fdp-primer/writing-style: Fix section level >=20 > 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(-) >=20 > diff --git a/documentation/content/en/books/fdp-primer/writing-style/_ind= ex.adoc b/documentation/content/en/books/fdp-primer/writing-style/_index.ad= oc > 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 shoul= d act towards one another i > .... >=20 > [[writing-style-acronyms]] > -=3D=3D=3D Acronyms > +=3D=3D Acronyms >=20 > Acronyms should be defined the first time they appear in a document, as i= n: "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.