Skip to content

Commit a455c47

Browse files
committed
Punt on test extra.
1 parent 44808d0 commit a455c47

File tree

1 file changed

+19
-12
lines changed

1 file changed

+19
-12
lines changed

spec-0013/index.md

Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -23,23 +23,30 @@ another and believe that consistency will make it both easier for existing
2323
maintainer to contribute to project as well a decrease the confusion of new
2424
developers when contributing or creating new projects.
2525

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).
2731

28-
We recommend that by default the targets and folder names:
32+
## Implementation
2933

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`.
3336

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:
3538

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.
3747

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.
4350

4451
## Notes
4552

0 commit comments

Comments
 (0)