@@ -124,6 +124,7 @@ def callback(
124
124
while a callback is running, the callback is canceled.
125
125
Note that the value of the property is not significant, any change in
126
126
value will result in the cancellation of the running job (if any).
127
+ This parameter only applies to background callbacks (`background=True`).
127
128
:param progress:
128
129
An `Output` dependency grouping that references properties of
129
130
components in the app's layout. When provided, the decorated function
@@ -132,21 +133,25 @@ def callback(
132
133
function should call in order to provide updates to the app on its
133
134
current progress. This function accepts a single argument, which
134
135
correspond to the grouping of properties specified in the provided
135
- `Output` dependency grouping
136
+ `Output` dependency grouping. This parameter only applies to background
137
+ callbacks (`background=True`).
136
138
:param progress_default:
137
139
A grouping of values that should be assigned to the components
138
140
specified by the `progress` argument when the callback is not in
139
141
progress. If `progress_default` is not provided, all the dependency
140
142
properties specified in `progress` will be set to `None` when the
141
- callback is not running.
143
+ callback is not running. This parameter only applies to background
144
+ callbacks (`background=True`).
142
145
:param cache_args_to_ignore:
143
146
Arguments to ignore when caching is enabled. If callback is configured
144
147
with keyword arguments (Input/State provided in a dict),
145
148
this should be a list of argument names as strings. Otherwise,
146
149
this should be a list of argument indices as integers.
150
+ This parameter only applies to background callbacks (`background=True`).
147
151
:param cache_ignore_triggered:
148
152
Whether to ignore which inputs triggered the callback when creating
149
- the cache.
153
+ the cache. This parameter only applies to background callbacks
154
+ (`background=True`).
150
155
:param interval:
151
156
Time to wait between the background callback update requests.
152
157
:param on_error:
0 commit comments