Skip to content

Commit cf4b04b

Browse files
committed
key args
1 parent 573c17b commit cf4b04b

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

packages/service-library/src/servicelib/logging_errors.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212

1313
def create_troubleshotting_log_message(
1414
error_user_msg: str,
15+
*,
1516
error: BaseException,
1617
error_code: ErrorCodeStr,
1718
error_context: dict[str, Any] | None = None,
@@ -20,7 +21,7 @@ def create_troubleshotting_log_message(
2021
"""Create a formatted message for _logger.exception(...)
2122
2223
Arguments:
23-
message_to_user -- A user-friendly message to be displayed on the front-end explaining the issue in simple terms.
24+
error_user_msg -- A user-friendly message to be displayed on the front-end explaining the issue in simple terms.
2425
error -- the instance of the handled exception
2526
error_code -- A unique error code (e.g., OEC or osparc-specific) to identify the type or source of the error for easier tracking.
2627
error_context -- Additional context surrounding the exception, such as environment variables or function-specific data. This can be derived from exc.error_context() (relevant when using the OsparcErrorMixin)
@@ -47,6 +48,7 @@ class LogKwargs(TypedDict):
4748

4849
def create_troubleshotting_log_kwargs(
4950
error_user_msg: str,
51+
*,
5052
error: BaseException,
5153
error_context: dict[str, Any] | None = None,
5254
tip: str | None = None,

0 commit comments

Comments
 (0)