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