Skip to content

Commit 10ae13c

Browse files
committed
DOC: Improve docstring
1 parent 01502ba commit 10ae13c

File tree

1 file changed

+1
-2
lines changed

1 file changed

+1
-2
lines changed

octue/configuration.py

+1-2
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@
44

55
import yaml
66

7-
87
logger = logging.getLogger(__name__)
98

109

@@ -80,7 +79,7 @@ def from_file(cls, path=None, allow_not_found=False):
8079
"""Load a service configuration from a YAML file.
8180
8281
:param str|None path: the path to the service configuration YAML file; if not provided, the `OCTUE_SERVICE_CONFIGURATION_PATH` environment variable is used if present, otherwise the local path `octue.yaml` is used
83-
:param bool allow_not_found: if `True`, return `None` if a service configuration file isn't found
82+
:param bool allow_not_found: if `True`, return `None` instead of raising an error if a service configuration file isn't found
8483
:return ServiceConfiguration|None: the service configuration loaded from the file
8584
"""
8685
path = path or os.environ.get("OCTUE_SERVICE_CONFIGURATION_PATH", DEFAULT_SERVICE_CONFIGURATION_PATH)

0 commit comments

Comments
 (0)