Skip to content

Add note on params that only work with background callbacks #3263

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Apr 9, 2025

Conversation

LiamConnors
Copy link
Member

@T4rk1n do you know if there are any other params that only apply to background callbacks.

This PR relates to this issue https://github.com/plotly/ddk-dash-docs/issues/3318
which is specifically related to the cancel param, but I think it's the same for the rest of these.


Start with a description of this PR. Then edit the list below to the items that make sense for your PR scope, and check off the boxes as you go!

Contributor Checklist

  • I have broken down my PR scope into the following TODO tasks
    • task 1
    • task 2
  • I have run the tests locally and they passed. (refer to testing section in contributing)
  • I have added tests, or extended existing tests, to cover any new features or bugs fixed in this PR

optionals

  • I have added entry in the CHANGELOG.md
  • If this PR needs a follow-up in dash docs, community thread, I have mentioned the relevant URLS as follows
    • this GitHub #PR number updates the dash docs
    • here is the show and tell thread in Plotly Dash community

@gvwilson gvwilson added documentation written for humans feature something new P1 needed for current cycle labels Apr 8, 2025
@@ -118,12 +118,14 @@ def callback(
the app layout. The second element is the value that the property
should be set to while the callback is running, and the third element
is the value the property should be set to when the callback completes.
This parameter only applies to background callbacks (`background=True`).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Running is available for regular callbacks since 2.16

@T4rk1n
Copy link
Contributor

T4rk1n commented Apr 8, 2025

@T4rk1n do you know if there are any other params that only apply to background callbacks.

There is only interval but the wording in the docstring already implies background callbacks.

@LiamConnors LiamConnors marked this pull request as ready for review April 8, 2025 18:02
Copy link
Contributor

@gvwilson gvwilson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The prose looks good, but I'll defer to @T4rk1n on correctness.

Copy link
Contributor

@T4rk1n T4rk1n left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💃

@T4rk1n T4rk1n merged commit 66316c6 into dev Apr 9, 2025
3 checks passed
@T4rk1n T4rk1n deleted the update-dash-doc branch April 9, 2025 13:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation written for humans feature something new P1 needed for current cycle
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants