From: Stephen Hemminger <stephen@networkplumber.org>
To: dev@dpdk.org
Cc: Stephen Hemminger <stephen@networkplumber.org>
Subject: [PATCH 04/11] doc: improve documentation guidelines style
Date: Wed, 14 Jan 2026 14:54:08 -0800 [thread overview]
Message-ID: <20260114225555.127448-5-stephen@networkplumber.org> (raw)
In-Reply-To: <20260114225555.127448-1-stephen@networkplumber.org>
Improve readability of the documentation guidelines
- Using active voice throughout
- Converting "should be" constructions to imperative mood
- Fixing minor grammar issues in Doxygen guidance
No technical content changes.
Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
---
doc/guides/contributing/documentation.rst | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/doc/guides/contributing/documentation.rst b/doc/guides/contributing/documentation.rst
index 338254cf30..c6009cbc12 100644
--- a/doc/guides/contributing/documentation.rst
+++ b/doc/guides/contributing/documentation.rst
@@ -39,7 +39,7 @@ The main directories that contain files related to documentation are shown below
|-- ...
-The API documentation is built from `Doxygen <http://www.doxygen.nl>`_ comments in the header files.
+Doxygen comments in header files generate the API documentation. These are built from `Doxygen <http://www.doxygen.nl>`_ comments in the header files.
These files are mainly in the ``lib/*`` directories although some of the Poll Mode Drivers in ``drivers/net``
are also documented with Doxygen.
@@ -84,7 +84,7 @@ added to by the developer.
The API documentation explains how to use the public DPDK functions.
The `API index page <https://doc.dpdk.org/api/>`_ shows the generated API documentation with related groups of functions.
- The API documentation should be updated via Doxygen comments when new functions are added.
+ Update API documentation via Doxygen comments when adding new functions.
* **Getting Started Guides**
@@ -606,7 +606,7 @@ The following are some guidelines for use of Doxygen in the DPDK API documentati
It isn't necessary to explicitly name each file since the configuration matches all ``rte_*.h`` files in the directory.
* Use proper capitalization and punctuation in the Doxygen comments since they will become sentences in the documentation.
- This in particular applies to single line comments, which is the case the is most often forgotten.
+ This applies particularly to single-line comments, which developers most often forget.
* Use ``@`` style Doxygen commands instead of ``\`` style commands.
--
2.51.0
next prev parent reply other threads:[~2026-01-14 22:56 UTC|newest]
Thread overview: 26+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-01-14 22:54 [PATCH 00/11] doc: improve contributing documentation clarity and style Stephen Hemminger
2026-01-14 22:54 ` [PATCH 01/11] doc: correct grammar and typos in design guide Stephen Hemminger
2026-01-14 22:54 ` [PATCH 02/11] doc: improve ABI policy documentation style Stephen Hemminger
2026-01-14 22:54 ` [PATCH 03/11] doc: improve coding style guide readability Stephen Hemminger
2026-01-14 22:54 ` Stephen Hemminger [this message]
2026-01-14 22:54 ` [PATCH 05/11] doc: improve Linux uAPI header documentation Stephen Hemminger
2026-01-14 22:54 ` [PATCH 06/11] doc: improve new driver guide readability Stephen Hemminger
2026-01-14 22:54 ` [PATCH 07/11] doc: improve new library guide style Stephen Hemminger
2026-01-14 22:54 ` [PATCH 08/11] doc: improve patch submission guide readability Stephen Hemminger
2026-01-14 22:54 ` [PATCH 09/11] doc: improve stable releases documentation Stephen Hemminger
2026-01-14 22:54 ` [PATCH 10/11] doc: improve unit test guide readability Stephen Hemminger
2026-01-14 22:54 ` [PATCH 11/11] doc: improve vulnerability process documentation Stephen Hemminger
2026-01-16 20:14 ` [PATCH v2 00/12] doc: improve contributing documentation clarity and style Stephen Hemminger
2026-01-16 20:14 ` [PATCH v2 01/12] doc: correct grammar and typos in design guide Stephen Hemminger
2026-03-31 22:41 ` Stephen Hemminger
2026-01-16 20:14 ` [PATCH v2 02/12] doc: improve ABI policy documentation style Stephen Hemminger
2026-01-16 20:14 ` [PATCH v2 03/12] doc: improve coding style guide readability Stephen Hemminger
2026-01-16 20:14 ` [PATCH v2 04/12] doc: improve documentation guidelines style Stephen Hemminger
2026-01-16 20:14 ` [PATCH v2 05/12] doc: improve Linux uAPI header documentation Stephen Hemminger
2026-01-16 20:14 ` [PATCH v2 06/12] doc: improve new driver guide readability Stephen Hemminger
2026-01-16 20:14 ` [PATCH v2 07/12] doc: improve new library guide style Stephen Hemminger
2026-01-16 20:14 ` [PATCH v2 08/12] doc: improve patch submission guide readability Stephen Hemminger
2026-01-16 20:14 ` [PATCH v2 09/12] doc: improve stable releases documentation Stephen Hemminger
2026-01-16 20:14 ` [PATCH v2 10/12] doc: improve vulnerability process documentation Stephen Hemminger
2026-01-16 20:14 ` [PATCH v2 11/12] doc: improve unit test guide readability Stephen Hemminger
2026-01-16 20:14 ` [PATCH v2 12/12] doc: fix grammar and style in ABI versioning guide Stephen Hemminger
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20260114225555.127448-5-stephen@networkplumber.org \
--to=stephen@networkplumber.org \
--cc=dev@dpdk.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox