From nobody Sun Apr 23 09:30:00 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 4Q42zX3zZ2z4777H for ; Sun, 23 Apr 2023 09:30:00 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (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 "mxrelay.nyi.freebsd.org", Issuer "R3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4Q42zX28yGz3C7b; Sun, 23 Apr 2023 09:30:00 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1682242200; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=O8c2RaxIZt09XKXRg2m0kG8kf4csWZh34IH3Nu52d2Q=; b=gG43B5rct2KwSNO8MpTJqJGmt6butfJhr8TIzxHXavwKADmyrM06H/ACh668309AJaTeSv qYr5cx66sQiONwah7owmt7cO4j/ARNTAHsLxPfdz2ZTqEm9XK0PsKUz4IJchTUqY41Fitt RBP5aP9pA4nJDSuP7OEVGWWWenx+K/WfKB1dxrgz4Zy7my1pje7jTEtDZmlaKMaowP1XvQ BwwmHaQLcTTJPtelXa6SIbU4CWQQHpZGI46AQev8SpU7ojpoI2ufM0nzp/dGQvT7e1Fvkm G8e8y9QhufY0zOdz/2P/8hJAuRIh3h9bLaR8wrzwKDN61FwTlkq/XvJRVn205g== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1682242200; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=O8c2RaxIZt09XKXRg2m0kG8kf4csWZh34IH3Nu52d2Q=; b=Lckth29kr5hVfjISbC5s3fq1e5Ys3eRTu8LAfR83WsxaeK52lrSmx7ZaDNAScijuBDs0ii Eh4GTmwGtd3DydnHAC+6STV3QOk8Npha4mhh7leXYyQJVpjHaQe2YkZDWQauFMl5BjSyqj Bgo3ut6rR7hmuTdHzEvvLfPBeBTkMfJSWFROOqAqNwCOJ6n50/H0m3VlgIZkvOyzv4Iz8o WLuVVVpAlxrxNhvVkDcrkAASsy8bmEnnwer6DuZy0MAKoS/MQWckreeDV70hSFUzV39D0b 27CYt97Jt4v0EIxC2tnJ5GIbUPr22QzU7rLXvZx6vTfAh9jjv9POGz/6jn7tpg== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1682242200; a=rsa-sha256; cv=none; b=GMJEMauOovX6rUIMHWznbfJfn8Vq8xmbbQP0HXJaVUmMGQ448ae3719FvJOFP4AIuj9wJK 9KGD31GYwSOHRouKDeXg+GFsqZxzpTrlLJxGU0OESTu6y/E8CjKbf5EIjSDLOc5KaWfnNH TZ71NfAb6V9hbZFp+hGQbySQzTBHqQPqsoDp34ZB8bUhoxH/TgDBnBuU1mbFyXyORegmhY GZ4zHSVxvONRyXVD1cGDQpDLwsqBnvahlO0iPRSWH5l5WNP+8m+/zg5FPOdzAfL+elvtOt ryZ5D1fIDpghFALkkr6PWin6pGYK8X5koLBuxNaUmzcvWCWY1HNjXohzTqR3Mw== Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) (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 did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 4Q42zX1CYZzdws; Sun, 23 Apr 2023 09:30:00 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.16.1/8.16.1) with ESMTP id 33N9U0Tl087403; Sun, 23 Apr 2023 09:30:00 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 33N9U0KK087402; Sun, 23 Apr 2023 09:30:00 GMT (envelope-from git) Date: Sun, 23 Apr 2023 09:30:00 GMT Message-Id: <202304230930.33N9U0KK087402@gitrepo.freebsd.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org From: Lorenzo Salvadore Subject: git: 47b7701125 - main - fdp-primer/writing-style: Fix section level 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: 8bit X-Git-Committer: salvadore X-Git-Repository: doc X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: 47b7701125a7ef4157cfa9e8318d61b6663175bb Auto-Submitted: auto-generated X-ThisMailContainsUnwantedMimeParts: N The branch main has been updated by salvadore: URL: https://cgit.FreeBSD.org/doc/commit/?id=47b7701125a7ef4157cfa9e8318d61b6663175bb commit 47b7701125a7ef4157cfa9e8318d61b6663175bb Author: Lorenzo Salvadore AuthorDate: 2023-04-23 09:06:59 +0000 Commit: Lorenzo Salvadore 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.