Skip to content

Commit

Permalink
Punt on test extra.
Browse files Browse the repository at this point in the history
  • Loading branch information
Carreau committed Jun 5, 2024
1 parent 44808d0 commit a5ffa74
Showing 1 changed file with 19 additions and 12 deletions.
31 changes: 19 additions & 12 deletions spec-0013/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,23 +23,30 @@ another and believe that consistency will make it both easier for existing
maintainer to contribute to project as well a decrease the confusion of new
developers when contributing or creating new projects.

## Implementation
There seem to be a strong consensus with preference for `docs` in favor of
`docs`, and a preference for `tests` in favor of `test`.

We will note though that the *extra* optional dependencies on PyPI seem to favor
`test` (present on 7573 packages) vs `tests` (2362 times).

We recommend that by default the targets and folder names:
## Implementation

- related to testing be named `tests` (and not `test`)
- related to documentation be named `docs` (and not `doc`)
- both should be lowercase.
For the tie being we will not pronounce ourselves on the optional extra
`extra` dependency for `pyproject.toml`.

It is ok to have the singular aliases, but the plurals should always be the default.
For other targets and folders we recommend that:

### Examples
- Targets related to testing be named `tests` (and not `test`). For example
`spin tests`, `python dev.py tests`, `nox -s tests`.
- Folders containing tests be names `tests`.
- Targets related to documentations be named `docs` (and not `doc`). For example
`spin docs`, `make docs`, `tox -s docs`.
- That the documentation `extra` optional dependency be named `docs` (and not
doc), so that docs dependencies can be installed with `pip install .[docs]`
- Use lowercase.

pyproj.toml
docs folder
pip install .[]
spin and dev.py
tox
It is appropriate to have the singular aliases to ease transition, but the
plurals should always be the default.

## Notes

Expand Down

0 comments on commit a5ffa74

Please sign in to comment.