From b7e0c40d299cfefca2e68db5ab9d3d26b013bdf8 Mon Sep 17 00:00:00 2001 From: Frederik Rietdijk Date: Sun, 26 Aug 2018 09:31:39 +0200 Subject: [PATCH] docs python: `python.buildEnv` does not include `buildPythonApplication` modules Clarify the issue encountered at https://github.com/NixOS/nixpkgs/issues/45503 --- doc/languages-frameworks/python.section.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/doc/languages-frameworks/python.section.md b/doc/languages-frameworks/python.section.md index 93eb5af0f2c..d825823d01a 100644 --- a/doc/languages-frameworks/python.section.md +++ b/doc/languages-frameworks/python.section.md @@ -645,9 +645,15 @@ in python.withPackages(ps: [ps.blaze])).env #### `buildPythonApplication` function -The `buildPythonApplication` function is practically the same as `buildPythonPackage`. -The difference is that `buildPythonPackage` by default prefixes the names of the packages with the version of the interpreter. -Because this is irrelevant for applications, the prefix is omitted. +The `buildPythonApplication` function is practically the same as +`buildPythonPackage`. The main purpose of this function is to build a Python +package where one is interested only in the executables, and not importable +modules. For that reason, when adding this package to a `python.buildEnv`, the +modules won't be made available. + +Another difference is that `buildPythonPackage` by default prefixes the names of +the packages with the version of the interpreter. Because this is irrelevant for +applications, the prefix is omitted. #### `toPythonApplication` function