summary refs log tree commit diff
path: root/doc/languages-frameworks
diff options
context:
space:
mode:
authorJörg Thalheim <joerg@thalheim.io>2018-08-30 23:07:21 +0100
committerJörg Thalheim <joerg@thalheim.io>2018-08-31 06:52:53 +0100
commite5124b0f7571b506d5d0a9a47579db55fae3de1e (patch)
tree63753f9589a282435cb5469641502a8628fdc5a1 /doc/languages-frameworks
parent94f71d800db2ef7afb9fc8dad9e9aa503bfa2941 (diff)
downloadnixlib-e5124b0f7571b506d5d0a9a47579db55fae3de1e.tar
nixlib-e5124b0f7571b506d5d0a9a47579db55fae3de1e.tar.gz
nixlib-e5124b0f7571b506d5d0a9a47579db55fae3de1e.tar.bz2
nixlib-e5124b0f7571b506d5d0a9a47579db55fae3de1e.tar.lz
nixlib-e5124b0f7571b506d5d0a9a47579db55fae3de1e.tar.xz
nixlib-e5124b0f7571b506d5d0a9a47579db55fae3de1e.tar.zst
nixlib-e5124b0f7571b506d5d0a9a47579db55fae3de1e.zip
doc/python: convention for attributes names
cc @FRidh, @dotlambda
Diffstat (limited to 'doc/languages-frameworks')
-rw-r--r--doc/languages-frameworks/python.section.md3
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/languages-frameworks/python.section.md b/doc/languages-frameworks/python.section.md
index d825823d01a2..53bccc747255 100644
--- a/doc/languages-frameworks/python.section.md
+++ b/doc/languages-frameworks/python.section.md
@@ -1074,4 +1074,5 @@ Following rules are desired to be respected:
 * 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 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)