Skip to content

docs: Mention context managers in docs index page #232

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
edgarrmondragon merged 2 commits into from
Oct 29, 2026
Merged

docs: Mention context managers in docs index page #232

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
68b850a
docs: Mention context managers in docs index page
edgarrmondragon Oct 29, 2026
d21785a
Merge branch 'main' into docs/mention-context-managers
edgarrmondragon Oct 29, 2026
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
1 change: 1 addition & 0 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ This module provides function decorators which can be used to wrap a function su
## Features

- **Simple decorators** - Easy-to-use `@backoff.on_exception` and `@backoff.on_predicate` decorators
- **Context managers** - `backoff.retry_context()` and `backoff.aretry_context()` add retries to arbitrary blocks of code
- **Multiple wait strategies** - Exponential, fibonacci, constant, and runtime-configurable strategies
- **Flexible configuration** - Control retry limits with `max_time`, `max_tries`, and custom give-up conditions
- **Event handlers** - Hook into retry lifecycle with `on_success`, `on_backoff`, `on_giveup` and `on_try` callbacks
Expand Down
2 changes: 1 addition & 1 deletion docs/user-guide/context-manager.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Backoff provides a context manager generator for non-decorator usage.

!!! info "New in version 2.4.0"

`backoff.retry_context()` and its async counterpart `backoff.aretry_context()`
[`backoff.retry_context()`][backoff.retry_context] and its async counterpart [`backoff.aretry_context()`][backoff.aretry_context]
were added in v2.4.0.

## Basic Usage
Expand Down