Skip to content

Commit c8cbfe0

Browse files
authored
Modify code comment for Worker build_id field #1160 (#1163)
* Modify code comment for Worker build_id field #1160 Solves #1160 by including language informing users that large codebase may result in long worker startup time when no build_id is given. * Indent properly
1 parent f03ddc2 commit c8cbfe0

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

temporalio/worker/_worker.py

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -203,9 +203,11 @@ def __init__(
203203
interceptors already on the client that also implement
204204
:py:class:`Interceptor` are prepended to this list and should
205205
not be explicitly given here.
206-
build_id: Unique identifier for the current runtime. This is best
207-
set as a hash of all code and should change only when code does.
208-
If unset, a best-effort identifier is generated.
206+
build_id: A unique identifier for the current runtime, ideally provided as a
207+
representation of the complete source code. If not explicitly set, the system
208+
automatically generates a best-effort identifier by traversing and computing
209+
hashes of all modules in the codebase. In very large codebases this automatic
210+
process may significantly increase initialization time.
209211
Exclusive with `deployment_config`.
210212
WARNING: Deprecated. Use `deployment_config` instead.
211213
identity: Identity for this worker client. If unset, the client

0 commit comments

Comments
 (0)