@@ -23,23 +23,30 @@ another and believe that consistency will make it both easier for existing
23
23
maintainer to contribute to project as well a decrease the confusion of new
24
24
developers when contributing or creating new projects.
25
25
26
- ## Implementation
26
+ There seem to be a strong consensus with preference for ` docs ` in favor of
27
+ ` docs ` , and a preference for ` tests ` in favor of ` test ` .
28
+
29
+ We will note though that the _ extra_ optional dependencies on PyPI seem to favor
30
+ ` test ` (present on 7573 packages) vs ` tests ` (2362 times).
27
31
28
- We recommend that by default the targets and folder names:
32
+ ## Implementation
29
33
30
- - related to testing be named ` tests ` (and not ` test ` )
31
- - related to documentation be named ` docs ` (and not ` doc ` )
32
- - both should be lowercase.
34
+ For the tie being we will not pronounce ourselves on the optional extra
35
+ ` extra ` dependency for ` pyproject.toml ` .
33
36
34
- It is ok to have the singular aliases, but the plurals should always be the default.
37
+ For other targets and folders we recommend that:
35
38
36
- ### Examples
39
+ - Targets related to testing be named ` tests ` (and not ` test ` ). For example
40
+ ` spin tests ` , ` python dev.py tests ` , ` nox -s tests ` .
41
+ - Folders containing tests be names ` tests ` .
42
+ - Targets related to documentations be named ` docs ` (and not ` doc ` ). For example
43
+ ` spin docs ` , ` make docs ` , ` tox -s docs ` .
44
+ - That the documentation ` extra ` optional dependency be named ` docs ` (and not
45
+ doc), so that docs dependencies can be installed with ` pip install .[docs] `
46
+ - Use lowercase.
37
47
38
- pyproj.toml
39
- docs folder
40
- pip install .[ ]
41
- spin and dev.py
42
- tox
48
+ It is appropriate to have the singular aliases to ease transition, but the
49
+ plurals should always be the default.
43
50
44
51
## Notes
45
52
0 commit comments