Skip to content

Commit bc50226

Browse files
committed
docs: Fix parse_get_managed_objects arguments description
It was missing `on_unknown_member` description, the second argument had copy pasted name `interfaces_added_data`. Also add the link to it in the `DbusObjectManagerInterfaceAsync.get_managed_objects` description.
1 parent b3c5401 commit bc50226

2 files changed

Lines changed: 8 additions & 2 deletions

File tree

docs/asyncio_api.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -192,6 +192,9 @@ Classes
192192

193193
Get the objects this object manager in managing.
194194

195+
:py:func:`sdbus.utils.parse_get_managed_objects` can be used
196+
to make returned data easier to work with.
197+
195198
:return:
196199
Triple nested dictionary that contains all the objects
197200
paths with their properties values.

docs/utils.rst

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,10 +70,13 @@ Parsing utilities
7070

7171
:param Iterable[DbusInterfaceBaseAsync] interfaces: Possible interfaces of the managed objects.
7272
Can accept classes with multiple interfaces defined.
73-
:param Dict interfaces_added_data: Data returned by ``get_managed_objects`` call.
74-
:param str on_unknown_member: If an unknown D-Bus interface was encountered
73+
:param Dict managed_objects_data: Data returned by ``get_managed_objects`` call.
74+
:param str on_unknown_interface: If an unknown D-Bus interface was encountered
7575
either raise an ``"error"`` (default) or return ``"none"`` instead
7676
of interface class.
77+
:param str on_unknown_member: If an unknown D-Bus property was encountered
78+
either raise an ``"error"`` (default), ``"ignore"`` the property
79+
or ``"reuse"`` the D-Bus name for the member.
7780
:rtype: Dict[str, Tuple[Optional[Type[DbusInterfaceBaseAsync], Dict[str, Any]]]]
7881
:returns: Dictionary where keys are paths and values are tuples of managed objects classes and their properties data.
7982

0 commit comments

Comments
 (0)