From a31a1edc638c58eac8c85d71bc1fc8513f195031 Mon Sep 17 00:00:00 2001
From: Anas Khan <anxkhn28@gmail.com>
Date: Tue, 7 Jul 2026 19:48:13 +0530
Subject: [PATCH] fix(python-sdk): correct inverted no_install_recommends
 docstring (#1532)

`TemplateBuilder.apt_install()` documents its `no_install_recommends`
parameter as
"Whether to install recommended packages", but the generated command
does the
opposite. In `packages/python-sdk/e2b/template/main.py` the command adds
apt-get's
`--no-install-recommends` flag when the argument is `True`:

```python
f"... apt-get install -y {'--no-install-recommends ' if no_install_recommends else ''}..."
```

`--no-install-recommends` tells apt to *skip* recommended packages, so
`no_install_recommends=True` skips them rather than installing them. A
user who
follows the docstring gets the inverse of the documented behavior. The
parameter
name and apt-get's own semantics confirm the code is correct and the
docstring was
wrong; this rewords the docstring line to match the real behavior.

The `--no-install-recommends` flag was introduced in #983; the docstring
has been
inverted since then.

This is Python-only. The JS twin `aptInstall` applies the same flag but
has no
per-parameter JSDoc for `noInstallRecommends` (it appears only inside an
`@example`), so there is nothing contradictory to fix on the JS side.
There is a
single Python definition (no sync/async mirror for the template
builder).

No behavior change.

### Usage

```python
from e2b import Template

template = Template().from_image("ubuntu:22.04")

# Install recommended packages as well (apt-get default):
template.apt_install("vim")

# Skip recommended packages (adds apt-get's --no-install-recommends):
template.apt_install("vim", no_install_recommends=True)
```

---

## Commit(s)

- `9a860642` fix(python-sdk): correct inverted no_install_recommends
docstring
  - `packages/python-sdk/e2b/template/main.py` (1 docstring line)
- `.changeset/python-apt-install-docstring.md` (`@e2b/python-sdk:
patch`, new)

Diff: +10 / -1 across 2 files. No logic touched.

---

## Verification (run locally in `packages/python-sdk`)

- `ruff format --check e2b/template/main.py` -> already formatted (exit
0)
- `ruff check e2b/template/main.py` -> All checks passed (exit 0)
- `ty check` -> 47 diagnostics, all pre-existing (paginator.py,
sandbox_api.py,
test files); zero in the changed file. A comment-only edit cannot affect
typing.

No dedicated regression test: this is a documentation-only fix with no
runtime
branch to cover, matching the merged docstring-correctness precedents
(#1500 /
#1511 `Sandbox.list`, #1260 `write_files`).

Signed-off-by: Anas Khan <83116240+anxkhn@users.noreply.github.com>
---
 .changeset/python-apt-install-docstring.md | 9 +++++++++
 packages/python-sdk/e2b/template/main.py   | 2 +-
 2 files changed, 10 insertions(+), 1 deletion(-)
 create mode 100644 .changeset/python-apt-install-docstring.md

diff --git a/.changeset/python-apt-install-docstring.md b/.changeset/python-apt-install-docstring.md
new file mode 100644
index 0000000000..b555098903
--- /dev/null
+++ b/.changeset/python-apt-install-docstring.md
@@ -0,0 +1,9 @@
+---
+"@e2b/python-sdk": patch
+---
+
+Fix inverted `no_install_recommends` docstring on `TemplateBuilder.apt_install()`.
+The docstring described the parameter as "Whether to install recommended
+packages", but the code passes apt-get's `--no-install-recommends` flag when the
+argument is `True`, which skips recommended packages, the opposite of what the
+docs claimed. The docstring now describes the real behavior. No behavior change.
diff --git a/packages/python-sdk/e2b/template/main.py b/packages/python-sdk/e2b/template/main.py
index 8b75642ca3..c92e07638c 100644
--- a/packages/python-sdk/e2b/template/main.py
+++ b/packages/python-sdk/e2b/template/main.py
@@ -478,7 +478,7 @@ def apt_install(
         Install system packages using apt-get.
 
         :param packages: Package name(s) to install
-        :param no_install_recommends: Whether to install recommended packages
+        :param no_install_recommends: Whether to skip installing recommended packages
         :param fix_missing: Whether to fix missing packages
 
         :return: `TemplateBuilder` class