Skip to content

Commit 66316c6

Browse files
authored
Merge pull request #3263 from plotly/update-dash-doc
Add note on params that only work with background callbacks
2 parents 7189f32 + 13503d3 commit 66316c6

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

dash/_callback.py

+8-3
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,7 @@ def callback(
124124
while a callback is running, the callback is canceled.
125125
Note that the value of the property is not significant, any change in
126126
value will result in the cancellation of the running job (if any).
127+
This parameter only applies to background callbacks (`background=True`).
127128
:param progress:
128129
An `Output` dependency grouping that references properties of
129130
components in the app's layout. When provided, the decorated function
@@ -132,21 +133,25 @@ def callback(
132133
function should call in order to provide updates to the app on its
133134
current progress. This function accepts a single argument, which
134135
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`).
136138
:param progress_default:
137139
A grouping of values that should be assigned to the components
138140
specified by the `progress` argument when the callback is not in
139141
progress. If `progress_default` is not provided, all the dependency
140142
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`).
142145
:param cache_args_to_ignore:
143146
Arguments to ignore when caching is enabled. If callback is configured
144147
with keyword arguments (Input/State provided in a dict),
145148
this should be a list of argument names as strings. Otherwise,
146149
this should be a list of argument indices as integers.
150+
This parameter only applies to background callbacks (`background=True`).
147151
:param cache_ignore_triggered:
148152
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`).
150155
:param interval:
151156
Time to wait between the background callback update requests.
152157
:param on_error:

0 commit comments

Comments
 (0)