summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
authorFrederik Rietdijk <fridh@fridh.nl>2018-08-26 09:31:39 +0200
committerFrederik Rietdijk <fridh@fridh.nl>2018-08-26 09:31:39 +0200
commitb7e0c40d299cfefca2e68db5ab9d3d26b013bdf8 (patch)
tree69b2c3e21db7ac78a1ca221b5c347afdc4224a72 /doc
parent07ea150b5c7a4142fe5b590230d7bca8e3bece82 (diff)
downloadnixlib-b7e0c40d299cfefca2e68db5ab9d3d26b013bdf8.tar
nixlib-b7e0c40d299cfefca2e68db5ab9d3d26b013bdf8.tar.gz
nixlib-b7e0c40d299cfefca2e68db5ab9d3d26b013bdf8.tar.bz2
nixlib-b7e0c40d299cfefca2e68db5ab9d3d26b013bdf8.tar.lz
nixlib-b7e0c40d299cfefca2e68db5ab9d3d26b013bdf8.tar.xz
nixlib-b7e0c40d299cfefca2e68db5ab9d3d26b013bdf8.tar.zst
nixlib-b7e0c40d299cfefca2e68db5ab9d3d26b013bdf8.zip
docs python: `python.buildEnv` does not include `buildPythonApplication` modules
Clarify the issue encountered at
https://github.com/NixOS/nixpkgs/issues/45503
Diffstat (limited to 'doc')
-rw-r--r--doc/languages-frameworks/python.section.md12
1 files changed, 9 insertions, 3 deletions
diff --git a/doc/languages-frameworks/python.section.md b/doc/languages-frameworks/python.section.md
index 93eb5af0f2cc..d825823d01a2 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