Skip to content

Commit d6b022b

Browse files
committed
docs: Say which deployments watching mode does not follow
Watching follows edits to the configured files and to the targets of configured links, including a ConfigMap update, but not a link further along the path or a configured directory that is pointed elsewhere or replaced. The change detection documentation now says so and points such deployments to polling.
1 parent 71564d9 commit d6b022b

1 file changed

Lines changed: 6 additions & 0 deletions

File tree

‎ldclient/integrations/overrides.py‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -133,6 +133,12 @@ def change_detection(self, mode: Union[ChangeDetection, str]) -> 'FileOverrideSo
133133
:attr:`ChangeDetection.POLLING`. The two modes are alternatives, so setting one replaces
134134
the other. :attr:`ChangeDetection.WATCHING` requires the ``watchdog`` package.
135135
136+
Watching follows edits to the configured files and to the targets of configured symbolic
137+
links, including the update of a mounted Kubernetes ConfigMap. It does not follow a
138+
deployment that points a link further along the path, or a configured directory, at
139+
another location, such as a ``current`` link to a release directory, or that replaces a
140+
configured directory. Use polling for such deployments.
141+
136142
:param mode: the mode, as the enum or its string value (``"polling"`` or ``"watching"``)
137143
"""
138144
self.__change_detection = ChangeDetection(mode)

0 commit comments

Comments
 (0)