[PATCH] Documentation: iio: fix typo in triggered-buffers example

Stepan Ionichev posted 1 patch 1 month ago
There is a newer version of this series
Documentation/driver-api/iio/triggered-buffers.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
[PATCH] Documentation: iio: fix typo in triggered-buffers example
Posted by Stepan Ionichev 1 month ago
The function call example in triggered-buffers.rst uses "polfunc"
(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.

Signed-off-by: Stepan Ionichev <sozdayvek@gmail.com>
---
 Documentation/driver-api/iio/triggered-buffers.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/driver-api/iio/triggered-buffers.rst b/Documentation/driver-api/iio/triggered-buffers.rst
index 417555dbb..23b82357e 100644
--- a/Documentation/driver-api/iio/triggered-buffers.rst
+++ b/Documentation/driver-api/iio/triggered-buffers.rst
@@ -43,7 +43,7 @@ A typical triggered buffer setup looks like this::
     }
 
     /* setup triggered buffer, usually in probe function */
-    iio_triggered_buffer_setup(indio_dev, sensor_iio_polfunc,
+    iio_triggered_buffer_setup(indio_dev, sensor_iio_pollfunc,
                                sensor_trigger_handler,
                                sensor_buffer_setup_ops);
 
-- 
2.43.0
Re: [PATCH] Documentation: iio: fix typo in triggered-buffers example
Posted by Andy Shevchenko 1 month ago
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