Skip to content

Commit

Permalink
Update breeze mypy check documentation (#24609)
Browse files Browse the repository at this point in the history
  • Loading branch information
igorborgest authored Jun 22, 2022
1 parent 0527a0b commit 38c701c
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions BREEZE.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1019,31 +1019,31 @@ you have auto-complete setup you should see auto-completable list of all checks

.. code-block:: bash
breeze static-checks -t mypy
breeze static-checks -t run-mypy
The above will run mypy check for currently staged files.

You can also pass specific pre-commit flags for example ``--all-files`` :

.. code-block:: bash
breeze static-checks -t mypy --all-files
breeze static-checks -t run-mypy --all-files
The above will run mypy check for all files.

There is a convenience ``--last-commit`` flag that you can use to run static check on last commit only:

.. code-block:: bash
breeze static-checks -t mypy --last-commit
breeze static-checks -t run-mypy --last-commit
The above will run mypy check for all files in the last commit.

There is another convenience ``--commit-ref`` flag that you can use to run static check on specific commit:

.. code-block:: bash
breeze static-checks -t mypy --commit-ref 639483d998ecac64d0fef7c5aa4634414065f690
breeze static-checks -t run-mypy --commit-ref 639483d998ecac64d0fef7c5aa4634414065f690
The above will run mypy check for all files in the 639483d998ecac64d0fef7c5aa4634414065f690 commit.
Any ``commit-ish`` reference from Git will work here (branch, tag, short/long hash etc.)
Expand Down

0 comments on commit 38c701c

Please sign in to comment.