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
Clarify return values of ..._on_commit methods #8984
Clarify return values of ..._on_commit methods #8984
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #8984 +/- ##
==========================================
- Coverage 77.81% 77.81% -0.01%
==========================================
Files 150 150
Lines 18686 18686
Branches 3193 3193
==========================================
- Hits 14541 14540 -1
Misses 3854 3854
- Partials 291 292 +1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
@browniebroke Fixed the issues in I’m thinking out loud about merging this and releasing a patch version (v5.4.1), WDYT? The API originally did not return |
@browniebroke now it's more understandable than before 🚀 |
No way, is too much a "API change"? |
It did return
I don't think there is any rush to release a fix for this, the behaviour hasn't actually changed. The main change is in the docs IMO. |
Yup, you two are right - I didn't notice the nuance. Thank you for collaborating to fine tune the API! |
Note: Before submitting this pull request, please review our contributing
guidelines.
Description
Clarify return values for
delay_on_commit
andapply_async_on_commit
in the code and in the documentation.Fix #8976