diff options
author | github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> | 2021-03-24 12:11:57 +0000 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-03-24 12:11:57 +0000 |
commit | 380cb1e99543fa778c3051449ae90ab9c0ee3541 (patch) | |
tree | 1fdb482a8cb0611dc40bc951f13b7a1246b27aa4 /doc/languages-frameworks/python.section.md | |
parent | f29a6f587782235aed55403fe4386ce8f33e5b94 (diff) | |
parent | 6b74bbfb9603418fac02cda0352b70661eab2aa6 (diff) | |
download | nixpkgs-380cb1e99543fa778c3051449ae90ab9c0ee3541.tar nixpkgs-380cb1e99543fa778c3051449ae90ab9c0ee3541.tar.gz nixpkgs-380cb1e99543fa778c3051449ae90ab9c0ee3541.tar.bz2 nixpkgs-380cb1e99543fa778c3051449ae90ab9c0ee3541.tar.lz nixpkgs-380cb1e99543fa778c3051449ae90ab9c0ee3541.tar.xz nixpkgs-380cb1e99543fa778c3051449ae90ab9c0ee3541.tar.zst nixpkgs-380cb1e99543fa778c3051449ae90ab9c0ee3541.zip |
Merge master into staging-next
Diffstat (limited to 'doc/languages-frameworks/python.section.md')
-rw-r--r-- | doc/languages-frameworks/python.section.md | 19 |
1 files changed, 10 insertions, 9 deletions
diff --git a/doc/languages-frameworks/python.section.md b/doc/languages-frameworks/python.section.md index c0f1342a94f..e13101ed309 100644 --- a/doc/languages-frameworks/python.section.md +++ b/doc/languages-frameworks/python.section.md @@ -639,7 +639,7 @@ are disabled. #### Using pythonImportsCheck -Although unit tests are highly prefered to valid correctness of a package. Not +Although unit tests are highly prefered to validate correctness of a package, not all packages have test suites that can be ran easily, and some have none at all. To help ensure the package still works, `pythonImportsCheck` can attempt to import the listed modules. @@ -1569,13 +1569,11 @@ In a `setup.py` or `setup.cfg` it is common to declare dependencies: ### Contributing guidelines -Following rules are desired to be respected: +The following rules are desired to be respected: * Python libraries are 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 - alphanumerically to avoid merge conflicts and ease locating attributes. * Python applications live outside of `python-packages.nix` and are packaged with `buildPythonApplication`. * Make sure libraries build for all Python interpreters. @@ -1585,8 +1583,11 @@ Following rules are desired to be respected: case, when you disable tests, leave a comment explaining why. * Commit names of Python libraries should reflect that they are Python libraries, so write for example `pythonPackages.numpy: 1.11 -> 1.12`. -* Attribute names in `python-packages.nix` should be normalized according to - [PEP 0503](https://www.python.org/dev/peps/pep-0503/#normalized-names). This - means that characters should be converted to lowercase and `.` and `_` should - be replaced by a single `-` (foo-bar-baz instead of Foo__Bar.baz ) -* Attribute names in `python-packages.nix` should be sorted alphanumerically. +* Attribute names in `python-packages.nix` as well as `pname`s should match the + library's name on PyPI, but be normalized according to [PEP + 0503](https://www.python.org/dev/peps/pep-0503/#normalized-names). This means + that characters should be converted to lowercase and `.` and `_` should be + replaced by a single `-` (foo-bar-baz instead of Foo__Bar.baz). + If necessary, `pname` has to be given a different value within `fetchPypi`. +* Attribute names in `python-packages.nix` should be sorted alphanumerically to + avoid merge conflicts and ease locating attributes. |