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

Mark Brown broonie at kernel.org
Wed Aug 28 13:29:39 PDT 2024


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
> > On Tue, Aug 27, 2024 at 05:55:43PM +0800, Chen-Yu Tsai wrote:

> > > + * Return: pointer to a &struct regulator corresponding to the regulator
> > > + *      producer, or ERR_PTR() encoded negative error number.

> > (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.
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 488 bytes
Desc: not available
URL: <http://lists.infradead.org/pipermail/linux-arm-kernel/attachments/20240828/abb87f67/attachment.sig>


More information about the linux-arm-kernel mailing list