Linux Documentation
 help / color / mirror / Atom feed
From: Andy Shevchenko <andriy.shevchenko@intel.com>
To: Stepan Ionichev <sozdayvek@gmail.com>
Cc: corbet@lwn.net, jic23@kernel.org, dlechner@baylibre.com,
	nuno.sa@analog.com, andy@kernel.org, skhan@linuxfoundation.org,
	gregkh@linuxfoundation.org, hcazarim@yahoo.com,
	linux-doc@vger.kernel.org, linux-iio@vger.kernel.org,
	linux-kernel@vger.kernel.org
Subject: Re: [PATCH] Documentation: iio: fix typo in triggered-buffers example
Date: Wed, 13 May 2026 13:55:34 +0300	[thread overview]
Message-ID: <agRYppUhsyKs3WBt@ashevche-desk.local> (raw)
In-Reply-To: <20260513100657.8498-1-sozdayvek@gmail.com>

On Wed, May 13, 2026 at 03:06:57PM +0500, Stepan Ionichev wrote:
> The function call example in triggered-buffers.rst uses "polfunc"

No need to repeat the file name here, see below what is better to use.

> (single 'l') while the function is defined as "pollfunc" (double
> 'l') on line 24 and referenced as "pollfunc" further down on
> line 56. Fix the misspelling so the example is consistent.

Line references are fragile, try to describe in terms of section and example
(names).

...

Code fix is good, nevertheless.

-- 
With Best Regards,
Andy Shevchenko



      reply	other threads:[~2026-05-13 10:55 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-05-13 10:06 [PATCH] Documentation: iio: fix typo in triggered-buffers example Stepan Ionichev
2026-05-13 10:55 ` Andy Shevchenko [this message]

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=agRYppUhsyKs3WBt@ashevche-desk.local \
    --to=andriy.shevchenko@intel.com \
    --cc=andy@kernel.org \
    --cc=corbet@lwn.net \
    --cc=dlechner@baylibre.com \
    --cc=gregkh@linuxfoundation.org \
    --cc=hcazarim@yahoo.com \
    --cc=jic23@kernel.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-iio@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=nuno.sa@analog.com \
    --cc=skhan@linuxfoundation.org \
    --cc=sozdayvek@gmail.com \
    /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