Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

s/setup.cfg/pyproject.toml/ in the development docs #3058

Merged
merged 2 commits into from
Jul 6, 2023
Merged

s/setup.cfg/pyproject.toml/ in the development docs #3058

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a2ff3da
s/setup.cfg/pyproject.toml/ in the development docs
sk1p Jul 6, 2023
ca33f85
Update docs/development.rst
gaborbernat Jul 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/development.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,12 +94,12 @@ Code style guide

- First and foremost, the linters configured for the project must pass; this generally means following PEP-8 rules,
as codified by: ``flake8``, ``black``, ``isort``, ``pyupgrade``.
- The supported Python versions (and the code syntax to use) are listed in the ``setup.cfg`` file
in the ``options/python_requires`` entry. However, there are some files that have to be kept compatible
- The supported Python versions (and the code syntax to use) are listed in the ``pyproject.toml`` file
in the ``project/requires-python`` entry. However, there are some files that have to be kept compatible
with Python 2.7 to allow and test for running Python 2 envs from tox. They are listed in ``.pre-commit-config.yaml``
under ``repo: https://github.com/asottile/pyupgrade`` under ``hooks/exclude``.
Please do not attempt to modernize them to Python 3.x.
- Packaging options should be specified within ``setup.cfg``; ``setup.py`` is only kept for editable installs.
- Packaging options should be specified within ``pyproject.toml``.
gaborbernat marked this conversation as resolved.
Show resolved Hide resolved
- All code (tests too) must be type annotated as much as required by ``mypy``.
- We use a line length of 120.
- Exception messages should only be capitalized (and ended with a period/exclamation mark) if they are multi-sentenced,
Expand Down