Skip to content

docs: fix docs #22

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.

Sign up for GitHub

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
Arseniy-Popov merged 1 commit into from
Jul 22, 2026
Merged

docs: fix docs #22

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 3 additions & 5 deletions docs/docs/sqlbroker/tutorial.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,21 +155,19 @@ Set `ack_policy` on the subscriber to control what happens after handler executi
- `AckPolicy.NACK_ON_ERROR` — On success, [Acks](#ack){.internal-link} the message. On exception, [Nacks](#nack){.internal-link} the message. With `NoRetryStrategy()` or `None` in `retry_strategy`, this has the same effect as `REJECT_ON_ERROR`.
- `AckPolicy.MANUAL` — Requires explicit `msg.ack()`, `msg.nack()`, or `msg.reject()` in the handler. In the absence of explicit action, the message is [Rejected](#reject){.internal-link} as a safety precaution.

Automatic acknowledgement applies only if the handler did not already call one of the manual acknowledgement methods.

#### Manual

Use `AckPolicy.MANUAL` when the handler should decide the outcome explicitly with `msg.ack()`, `msg.nack()`, or `msg.reject()`.
Use `AckPolicy.MANUAL` when the handler *has* to apply the outcome explicitly with `msg.ack()`, `msg.nack()`, or `msg.reject()`.

```python linenums="1"
{!> docs_src/sqlbroker/acknowledgements.py [ln:29-39]!}
```

Manual acknowledgements can also be used with any other `ack_policy`, not just `AckPolicy.MANUAL`. They override the `ack_policy` driven action.
Manual acknowledgements can be used with any [`ack_policy`](#automatic-via-ackpolicy){.internal-link}: they override the automatic action.

### Retry strategies

When a message is [Nacked](#nack){.internal-link} (either manually with `msg.nack()` or by `AckPolicy.NACK_ON_ERROR`), the `retry_strategy` determines if and when the message should be retried. By default, `NoRetryStrategy()` disables retries. All strategies accept common parameters:
When a message is [Nacked](#nack){.internal-link} (either manually with `msg.nack()` or by `AckPolicy.NACK_ON_ERROR`), the `retry_strategy` determines if and when the message should be retried. The default strategy - `NoRetryStrategy()` - disables retries. All strategies accept as parameters:

- `max_attempts` - Maximum number of processing attempts.
- `max_total_delay_seconds` - Maximum delay between the first and last attempt.
Expand Down