Skip to content

Commit

Permalink
fix linter
Browse files Browse the repository at this point in the history
  • Loading branch information
Carreau committed Jun 5, 2024
1 parent 9a84ab6 commit 44808d0
Showing 1 changed file with 15 additions and 7 deletions.
22 changes: 15 additions & 7 deletions spec-0013/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,24 +12,32 @@ endorsed-by:

## Description

For consistency and decreased cognitive load across the ecosystem, this SPEC recommends naming conventions around various project aspects--such as project structure, repository layout, folder names, task runner and `pyproject.toml` targets name.
For consistency and decreased cognitive load across the ecosystem, this SPEC
recommends naming conventions around various project aspects--such as project
structure, repository layout, folder names, task runner and `pyproject.toml`
targets name.

From a cursory survey in the Scientific Python ecosystem, we discover some frustration from contributors and maintainer when moving from one project to another and belive 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.
From a cursory survey in the Scientific Python ecosystem, we discover some
frustration from contributors and maintainer when moving from one project to
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

We recommend that by default the targets and folder names:
- related to testing be named `tests` (and not `test`)
- related to documentation be named `docs` (and not `doc`)
- both should be lowercase.
We recommend that by default the targets and folder names:

- related to testing be named `tests` (and not `test`)
- related to documentation be named `docs` (and not `doc`)
- both should be lowercase.

It is ok to have the singular aliases, but the plurals should always be the default.

### Examples

pyproj.toml
docs folder
pip install .[]
pip install .[]
spin and dev.py
tox

Expand Down

0 comments on commit 44808d0

Please sign in to comment.