Skip to content

Commit

Permalink
docs: Fix parse_get_managed_objects arguments description
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
igo95862 committed Mar 17, 2024
1 parent b3c5401 commit bc50226
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 2 deletions.
3 changes: 3 additions & 0 deletions docs/asyncio_api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -192,6 +192,9 @@ Classes

Get the objects this object manager in managing.

:py:func:`sdbus.utils.parse_get_managed_objects` can be used
to make returned data easier to work with.

:return:
Triple nested dictionary that contains all the objects
paths with their properties values.
Expand Down
7 changes: 5 additions & 2 deletions docs/utils.rst
Original file line number Diff line number Diff line change
Expand Up @@ -70,10 +70,13 @@ Parsing utilities

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

Expand Down

0 comments on commit bc50226

Please sign in to comment.