doc/python: convention for attributes names #45822
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
9 tasks
dotlambda
reviewed
Aug 30, 2018
| @@ -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 -> foo-bar-baz) | |||
There was a problem hiding this comment.
Period is missing. I'd prefer using "instead of" or "→" instead of "->". Maybe use Foo__Bar.baz as example.
|
Thanks. I thought we had something in it already but it seems not. |
|
It says |
|
fixed |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
cc @FRidh, @dotlambda
Motivation for this change
#45644 (comment)
Things done
sandboxinnix.confon non-NixOS)nix-shell -p nox --run "nox-review wip"./result/bin/)nix path-info -Sbefore and after)