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

Revamp linting processes #7078

Merged
merged 20 commits into from
Sep 25, 2019
Merged

Revamp linting processes #7078

Changes from 1 commit
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
096cfb2
Add initial pre-commit configuration
pradyunsg Sep 24, 2019
dc5d2b9
Drop lint-py2 and mypy from tox environment
pradyunsg Sep 24, 2019
ea80263
Drop lint-py2 and mypy from Travis CI
pradyunsg Sep 24, 2019
9eab9d1
Drop lint-py2 and mypy from GitHub Actions CI
pradyunsg Sep 24, 2019
d0df9d3
Drop references to lint-py2 and mypy in documentation
pradyunsg Sep 24, 2019
7b005c2
Switch to using pre-commit in `tox lint`
pradyunsg Sep 24, 2019
0a25c7d
Document that pre-commit is used for linting
pradyunsg Sep 24, 2019
40a0f18
Enable check-builtin-literals
pradyunsg Sep 24, 2019
6f8c29a
Enable end-of-file-fixer
pradyunsg Sep 24, 2019
7224a11
Enable trailing-whitespace
pradyunsg Sep 24, 2019
ea68afa
Enable isort in pre-commit
pradyunsg Sep 24, 2019
c47e1b6
Enable rst-backticks for ReST files and NEWS fragments
pradyunsg Sep 24, 2019
ff53e6d
Drop dedicated CI job for NEWS fragment check
pradyunsg Sep 24, 2019
9a362ab
Exclude .pre-commit-config.yaml from distributions
pradyunsg Sep 24, 2019
8296b1a
Do twine check in Azure Pipeline's Package job
pradyunsg Sep 24, 2019
033a013
Drop tox -e packaging from CIs
pradyunsg Sep 24, 2019
f646349
Add pre-commit hook for check-manifest
pradyunsg Sep 24, 2019
1d1e672
Add invocation of mypy -2, to pre-commit
pradyunsg Sep 24, 2019
10beeea
Allow passing hook-ids to `tox -e lint`
pradyunsg Sep 25, 2019
9798d0f
Dedent hooks in .pre-commit-config.yaml
pradyunsg Sep 25, 2019
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
20 changes: 0 additions & 20 deletions docs/html/development/getting-started.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,26 +76,6 @@ To use linters locally, run:
.. code-block:: console

$ tox -e lint
$ tox -e lint-py2

The above commands run the linters on Python 3 followed by Python 2.

.. note::

Do not silence errors from flake8 with ``# noqa`` comments or otherwise.
pradyunsg marked this conversation as resolved.
Show resolved Hide resolved

Running mypy
------------

pip uses :pypi:`mypy` to run static type analysis, which helps catch certain
kinds of bugs. The codebase uses `PEP 484 type-comments`_ due to compatibility
requirements with Python 2.7.

To run the ``mypy`` type checker, run:

.. code-block:: console

$ tox -e mypy

Building Documentation
----------------------
Expand Down