diff options
| author | Frederik Rietdijk <fridh@fridh.nl> | 2017-02-22 13:38:02 +0100 |
|---|---|---|
| committer | Frederik Rietdijk <fridh@fridh.nl> | 2017-02-22 13:38:29 +0100 |
| commit | 026cfee6b0dce860841d85b8a50a00e944cf59a2 (patch) | |
| tree | a08c78eea16cc77533d5f5078753751b4410c566 /doc | |
| parent | 409dac4155f17e0431f14c231a28712e8b4308a7 (diff) | |
| download | nixpkgs-026cfee6b0dce860841d85b8a50a00e944cf59a2.tar nixpkgs-026cfee6b0dce860841d85b8a50a00e944cf59a2.tar.gz nixpkgs-026cfee6b0dce860841d85b8a50a00e944cf59a2.tar.bz2 nixpkgs-026cfee6b0dce860841d85b8a50a00e944cf59a2.tar.lz nixpkgs-026cfee6b0dce860841d85b8a50a00e944cf59a2.tar.xz nixpkgs-026cfee6b0dce860841d85b8a50a00e944cf59a2.tar.zst nixpkgs-026cfee6b0dce860841d85b8a50a00e944cf59a2.zip | |
Docs: update Python contributing guidelines
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/languages-frameworks/python.md | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/doc/languages-frameworks/python.md b/doc/languages-frameworks/python.md index 83d47b6f43a..19f241fb185 100644 --- a/doc/languages-frameworks/python.md +++ b/doc/languages-frameworks/python.md @@ -860,7 +860,8 @@ folder and not downloaded again. Following rules are desired to be respected: -* Make sure package builds for all python interpreters. Use `disabled` argument to `buildPythonPackage` to set unsupported interpreters. -* If tests need to be disabled for a package, make sure you leave a comment about reasoning. -* Packages in `pkgs/top-level/python-packages.nix` are sorted quasi-alphabetically to avoid merge conflicts. -* Python libraries are supposed to be in `python-packages.nix` and packaged with `buildPythonPackage`. Python applications live outside of `python-packages.nix` and are packaged with `buildPythonApplication`. +* Python libraries are supposed to be called from `python-packages.nix` and packaged with `buildPythonPackage`. The expression of a library should be in `pkgs/development/python-modules/<name>/default.nix`. Libraries in `pkgs/top-level/python-packages.nix` are sorted quasi-alphabetically to avoid merge conflicts. +* Python applications live outside of `python-packages.nix` and are packaged with `buildPythonApplication`. +* Make sure libraries build for all Python interpreters. +* By default we enable tests. Make sure the tests are found and, in the case of libraries, are passing for all interpreters. If certain tests fail they can be disabled individually. Try to avoid disabling the tests altogether. In any case, when you disable tests, leave a comment explaining why. +* Commit names of Python libraries should include `pythonPackages`, for example `pythonPackages.numpy: 1.11 -> 1.12`. |