Skip to content

Commit 35c0f97

Browse files
mchehabJonathan Corbet
authored andcommitted
docs: kdoc: improve description of MsgFormatter
The description there is quite vague. Make it clearer. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <94269990e2d665bec08a1b6f4d28d84939cb9d83.1768823489.git.mchehab+huawei@kernel.org>
1 parent 32e9a42 commit 35c0f97

1 file changed

Lines changed: 4 additions & 1 deletion

File tree

tools/docs/kernel-doc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,10 @@ return 0 if there are issues at kernel-doc markups;
182182
"""
183183

184184
class MsgFormatter(logging.Formatter):
185-
"""Helper class to format warnings in a similar way to kernel-doc.pl."""
185+
"""
186+
Helper class to capitalize errors and warnings, the same way
187+
the venerable (now retired) kernel-doc.pl used to do.
188+
"""
186189

187190
def format(self, record):
188191
record.levelname = record.levelname.capitalize()

0 commit comments

Comments
 (0)