Skip to content

Commit c92f0f3

Browse files
authored
docs: add undoc members to the documentation (#390)
1 parent 3d43728 commit c92f0f3

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

docs/index.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Subscribe to a set of keys with Zenoh
4646

4747
>>> import zenoh, time
4848
>>> def listener(sample):
49-
>>> print(f"{sample.key_expr} => {sample.payload.decode('utf-8')}")
49+
>>> print(f"{sample.key_expr} => {sample.payload.to_string()}")
5050
>>>
5151
>>> with zenoh.open() as session:
5252
>>> with session.declare_subscriber('demo/example/**', listener) as subscriber:
@@ -59,16 +59,18 @@ Get keys/values from zenoh
5959
>>> with zenoh.open() as session:
6060
>>> for response in session.get('demo/example/**'):
6161
>>> response = response.ok
62-
>>> print(f"{response.key_expr} => {response.payload.deserialize(str)}")
62+
>>> print(f"{response.key_expr} => {response.payload.to_string()}")
6363

6464
module zenoh
6565
============
6666

6767
.. automodule:: zenoh
6868
:members:
69+
:undoc-members:
6970

7071
module zenoh.handlers
7172
============
7273

7374
.. automodule:: zenoh.handlers
7475
:members:
76+
:undoc-members:

0 commit comments

Comments
 (0)