Skip to content

armgit / E2B

Public Imported from GitHub
0

Open-source, secure environment with real-world tools for enterprise-grade agents.

fix(python-sdk): correct inverted no_install_recommends docstring (#1533)

Mish Ushakov7474d904a2f6
diff --git a/.changeset/python-apt-install-docstring.md b/.changeset/python-apt-install-docstring.md
new file mode 100644
index 000000000..b55509890
--- /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 8b75642ca..c92e07638 100644
--- a/packages/python-sdk/e2b/template/main.py
+++ b/packages/python-sdk/e2b/template/main.py
@@ -478,7 +478,7 @@ class TemplateBuilder:
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