diff mbox series

[libgpiod,v4,06/17] bindings: gpiod: reword the docstring for LineRequest.__init__()

Message ID 20250211-improve-docs-v4-6-dc56702c2ca8@linaro.org
State New
Headers show
Series doc: improvements for ReadTheDocs | expand

Commit Message

Bartosz Golaszewski Feb. 11, 2025, 12:59 p.m. UTC 
From: Bartosz Golaszewski <bartosz.golaszewski@linaro.org>

Change the docstring for LineRequest.__init__() so that when it appears
in sphinx docs as part of the class description, it won't sound as if
the class was not to be used at all.

Signed-off-by: Bartosz Golaszewski <bartosz.golaszewski@linaro.org>
---
 bindings/python/gpiod/line_request.py | 6 ++----
 1 file changed, 2 insertions(+), 4 deletions(-)
diff mbox series

Patch

diff --git a/bindings/python/gpiod/line_request.py b/bindings/python/gpiod/line_request.py
index ef53e16..0220ba3 100644
--- a/bindings/python/gpiod/line_request.py
+++ b/bindings/python/gpiod/line_request.py
@@ -29,10 +29,8 @@  class LineRequest:
 
     def __init__(self, req: _ext.Request):
         """
-        DON'T USE
-
-        LineRequest objects can only be instantiated by a Chip parent. This is
-        not part of stable API.
+        Note: LineRequest objects can only be instantiated by a Chip parent.
+        LineRequest.__init__() is not part of stable API.
         """
         self._req: Union[_ext.Request, None] = req
         self._chip_name: str