From 58ad10b41afa8a0b71de7cf8ba004220e371a581 Mon Sep 17 00:00:00 2001 From: mejroslav Date: Tue, 1 Aug 2023 14:13:01 +0200 Subject: [PATCH] Add returning objects to docstrings --- asab/library/service.py | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/asab/library/service.py b/asab/library/service.py index 432064a18..53d279c88 100644 --- a/asab/library/service.py +++ b/asab/library/service.py @@ -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 '/' @@ -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)