public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
From: andy.shevchenko@gmail.com
To: Randy Dunlap <rdunlap@infradead.org>
Cc: Andy Shevchenko <andriy.shevchenko@linux.intel.com>,
	linux-iio@vger.kernel.org, linux-kernel@vger.kernel.org,
	Jonathan Cameron <jic23@kernel.org>,
	Lars-Peter Clausen <lars@metafoo.de>,
	Nuno Sa <nuno.sa@analog.com>
Subject: Re: [PATCH v2 6/8] iio: core: Fix issues and style of the comments
Date: Sat, 22 Jul 2023 00:37:31 +0300	[thread overview]
Message-ID: <ZLr6m5wHBSLKensj@surfacebook> (raw)
In-Reply-To: <db709099-a2aa-c03f-61bb-6130adfd6f4a@infradead.org>

Fri, Jul 21, 2023 at 01:48:34PM -0700, Randy Dunlap kirjoitti:
> On 7/21/23 10:00, Andy Shevchenko wrote:

...

> > - * Return: 0 for successful release
> > + * Returns: 0 for successful release.

> As documented in Documentation/doc-guide/kernel-doc.rst:
>   The return value, if any, should be described in a dedicated section
>   named ``Return``.
> 
> However, as you (and I) have found, "Returns:" also works as a section name.

Plural allowed for some section(s):
'\s*(\@[.\w]+|\@\.\.\.|description|context|returns?|notes?|examples?)\s*:([^:].*)?$'

> Reviewed-by: Randy Dunlap <rdunlap@infradead.org>

Thank you!

-- 
With Best Regards,
Andy Shevchenko



  reply	other threads:[~2023-07-21 21:37 UTC|newest]

Thread overview: 24+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-07-21 17:00 [PATCH v2 0/8] iio: core: A few code cleanups and documentation fixes Andy Shevchenko
2023-07-21 17:00 ` [PATCH v2 1/8] iio: core: Add opaque_struct_size() helper and use it Andy Shevchenko
2023-07-21 17:22   ` Andy Shevchenko
2023-07-21 17:25     ` Andy Shevchenko
2023-07-21 17:27       ` Andy Shevchenko
2023-07-21 18:12       ` Uwe Kleine-König
2023-07-21 17:00 ` [PATCH v2 2/8] iio: core: Use sysfs_match_string() helper Andy Shevchenko
2023-07-22 17:11   ` Jonathan Cameron
2023-07-21 17:00 ` [PATCH v2 3/8] iio: core: Switch to krealloc_array() Andy Shevchenko
2023-07-22 17:28   ` Jonathan Cameron
2023-07-24 10:37     ` Andy Shevchenko
2023-07-21 17:00 ` [PATCH v2 4/8] iio: core: Use min() instead of min_t() to make code more robust Andy Shevchenko
2023-07-23  9:14   ` Jonathan Cameron
2023-07-21 17:00 ` [PATCH v2 5/8] iio: core: Get rid of redundant 'else' Andy Shevchenko
2023-07-23  9:16   ` Jonathan Cameron
2023-07-21 17:00 ` [PATCH v2 6/8] iio: core: Fix issues and style of the comments Andy Shevchenko
2023-07-21 20:48   ` Randy Dunlap
2023-07-21 21:37     ` andy.shevchenko [this message]
2023-07-23  9:21   ` Jonathan Cameron
2023-07-21 17:00 ` [PATCH v2 7/8] iio: core: Move initcalls closer to the respective calls Andy Shevchenko
2023-07-23  9:23   ` Jonathan Cameron
2023-07-24 10:53     ` Andy Shevchenko
2023-07-21 17:00 ` [PATCH v2 8/8] iio: core: Improve indentation in a few places Andy Shevchenko
2023-07-23  9:24   ` Jonathan Cameron

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=ZLr6m5wHBSLKensj@surfacebook \
    --to=andy.shevchenko@gmail.com \
    --cc=andriy.shevchenko@linux.intel.com \
    --cc=jic23@kernel.org \
    --cc=lars@metafoo.de \
    --cc=linux-iio@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=nuno.sa@analog.com \
    --cc=rdunlap@infradead.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