Skip to content

Commit

Permalink
Add returning objects to docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
mejroslav committed Aug 1, 2023
1 parent d3ddd83 commit 58ad10b
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions asab/library/service.py
Original file line number Diff line number Diff line change
Expand Up @@ -202,6 +202,9 @@ async def list(self, path: str = "/", tenant: typing.Optional[str] = None, recur
path (str): Path to the directory.
tenant (str | None): If specified, items that are enabled for the tenant are filtered.
recursive (bool): If `True`, return a list of items located at `path` and its subdirectories.
Returns:
List of items that are enabled for the tenant.
"""

# Directory path must start with '/'
Expand Down Expand Up @@ -299,6 +302,9 @@ def check_disabled(self, path: str, tenant: typing.Optional[str] = None) -> bool
Args:
path (str): Path to the item to be checked.
tenant (str | None): The tenant to apply. If not specified, the global access is assumed.
Returns:
`True` if the item is enabled for the tenant.
"""

disabled = self.Disabled.get(path)
Expand Down

0 comments on commit 58ad10b

Please sign in to comment.