Thread (23 messages) 23 messages, 4 authors, 2024-08-28

Re: [PATCH 3/8] regulator: core: Fix incorrectly formatted kerneldoc "Return" sections

From: Mark Brown <broonie@kernel.org>
Date: 2024-08-28 20:29:51
Also in: lkml

On Wed, Aug 28, 2024 at 04:01:52PM +0800, Chen-Yu Tsai wrote:
On Tue, Aug 27, 2024 at 10:42 PM Andy Shevchenko
quoted
On Tue, Aug 27, 2024 at 05:55:43PM +0800, Chen-Yu Tsai wrote:
quoted
quoted
+ * Return: pointer to a &struct regulator corresponding to the regulator
+ *      producer, or ERR_PTR() encoded negative error number.
quoted
(I'm not sure of definite vs. indefinite article, though. Perhaps you need to
consult with native speaker.)
I think "a" makes more sense, because in the case of _regulator_get(),
the |struct regulator| consumer instances are allocated separately on
the fly for each call.
Your text is perfectly fine and completely intelligible.

Attachments

Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help