diff options
| author | Mauro Carvalho Chehab <mchehab+huawei@kernel.org> | 2026-01-19 15:04:59 +0300 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2026-01-21 01:31:06 +0300 |
| commit | 6cc45ee5df3bd89c8fa62aa2be91f747938686a1 (patch) | |
| tree | 270b86883cc04974d7c154fda456564e0adb4e8c /scripts/kernel-doc | |
| parent | bd28e99720f3f070e80551b5e94695640d3a730a (diff) | |
| download | linux-6cc45ee5df3bd89c8fa62aa2be91f747938686a1.tar.xz | |
docs: kdoc: some fixes to kernel-doc comments
There are some typos and English errors in the comments of kernel‑doc.py.
Locate them with the help of an LLM (gpt‑oss 14B), executed locally
with this prompt:
review English grammar and syntax at the comments on the code below:
<cat scripts/kernel-doc.py>
While LLM worked fine for the task of doing an English grammar review
for strings, being able to distinguish them from the actual code, it
was not is perfect: some things required manual work to fix.
-
While here, replace:
"/**" with: ``/**``
As, if we ever rename this script to kernel_doc.py and add it to
Sphinx ext autodoc, we want to avoid this warning:
scripts/kernel_doc.py:docstring of kernel_doc:10: WARNING: Inline strong start-string without end-string. [docutils]
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <ec08727f22ad35e6c58519c1f425f216f14b701c.1768823489.git.mchehab+huawei@kernel.org>
Diffstat (limited to 'scripts/kernel-doc')
0 files changed, 0 insertions, 0 deletions
