Skip to content

docs: clarify job callback contract#4

Merged
ccarvalho-eng merged 1 commit into
mainfrom
docs/job-contracts
May 22, 2026
Merged

docs: clarify job callback contract#4
ccarvalho-eng merged 1 commit into
mainfrom
docs/job-contracts

Conversation

@ccarvalho-eng

Copy link
Copy Markdown
Collaborator

Summary

  • document the metadata map passed to job callbacks in the README
  • clarify that snoozed jobs are rescheduled with an explicit delay and still count in retry accounting
  • align the job and worker moduledocs with the current snooze behavior

Document the metadata passed to job callbacks and align snooze return value docs with the current retry accounting behavior.
@ccarvalho-eng

Copy link
Copy Markdown
Collaborator Author

Open question on the snooze wording: current implementation appears to count {:snooze, delay_ms} in retry accounting because it flows through Store.requeue/4 and increments error_count, and the existing integration test asserts that behavior.

This PR updates the docs to match that current behavior. Just want to confirm that is intentional before we lock the wording in; if snooze is meant to be a pure delay without consuming retry budget, I can change this PR to leave the docs alone and open a behavior PR instead.

@ccarvalho-eng ccarvalho-eng requested a review from jallum May 21, 2026 01:42
@ccarvalho-eng ccarvalho-eng merged commit 2d5f1ee into main May 22, 2026
2 checks passed
@ccarvalho-eng ccarvalho-eng deleted the docs/job-contracts branch May 22, 2026 01:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant