procrastinate icon indicating copy to clipboard operation
procrastinate copied to clipboard

Fix doc to match function signature

Open ticosax opened this issue 5 months ago • 3 comments

Update code example for batch_defer(). (Arguments need to be expanded)

Successful PR Checklist:

  • [ ] Tests
    • [x] (not applicable?)
  • [x] Documentation
    • [ ] (not applicable?)

PR label(s):

  • [ ] https://github.com/procrastinate-org/procrastinate/labels/PR%20type%3A%20breaking%20%F0%9F%92%A5
  • [ ] https://github.com/procrastinate-org/procrastinate/labels/PR%20type%3A%20feature%20%E2%AD%90%EF%B8%8F
  • [ ] https://github.com/procrastinate-org/procrastinate/labels/PR%20type%3A%20bugfix%20%F0%9F%95%B5%EF%B8%8F
  • [ ] https://github.com/procrastinate-org/procrastinate/labels/PR%20type%3A%20miscellaneous%20%F0%9F%91%BE
  • [ ] https://github.com/procrastinate-org/procrastinate/labels/PR%20type%3A%20dependencies%20%F0%9F%A4%96
  • [x] https://github.com/procrastinate-org/procrastinate/labels/PR%20type%3A%20documentation%20%F0%9F%93%9A

ticosax avatar Jun 16 '25 11:06 ticosax

I've switched to the simpler

await my_task.batch_defer_async(
    {"a": 1, "b": 2},
    {"a": 3, "b": 4},
    {"a": 5, "b": 6},
)

with a note on using my_task.batch_defer(*payloads).

ewjoachim avatar Jun 16 '25 22:06 ewjoachim

(Pyright is not working on main, we'll need to fix it before we can merge, sorry about that)

ewjoachim avatar Jun 16 '25 22:06 ewjoachim

Main is fixed, if you can rebase, PR should be green :) (I'd do it but while repo maintainers can add commits, we can't force-push, and I'd like to avoid merge commits)

ewjoachim avatar Jun 21 '25 17:06 ewjoachim

Coverage report

This PR does not seem to contain any modification to coverable code.

github-actions[bot] avatar Jun 24 '25 09:06 github-actions[bot]