Skip to content

Commit f4ae7ba

Browse files
seismanweiji14
andauthored
Apply suggestions from code review
Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>
1 parent 18602d6 commit f4ae7ba

File tree

3 files changed

+3
-3
lines changed

3 files changed

+3
-3
lines changed

.github/workflows/ci_tests.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ jobs:
3535
pip install black blackdoc docformatter flake8 pylint isort
3636
sudo apt-get install dos2unix
3737
38-
- name: Formatting check (black and flake8)
38+
- name: Formatting check (black, blackdoc, docformatter, flake8 and isort)
3939
run: make check
4040

4141
- name: Linting (pylint)

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -274,7 +274,7 @@ common errors.
274274
The [`Makefile`](Makefile) contains rules for running both checks:
275275

276276
```bash
277-
make check # Runs flake8, black, blackdoc, docformatter and isort (in check mode)
277+
make check # Runs black, blackdoc, docformatter, flake8 and isort (in check mode)
278278
make lint # Runs pylint, which is a bit slower
279279
```
280280

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ help:
1717
@echo " install install in editable mode"
1818
@echo " test run the test suite (including doctests) and report coverage"
1919
@echo " format run black, blackdoc, docformatter and isort to automatically format the code"
20-
@echo " check run code style and quality checks (black, blackdoc, docformatter, isort and flake8)"
20+
@echo " check run code style and quality checks (black, blackdoc, docformatter, flake8 and isort)"
2121
@echo " lint run pylint for a deeper (and slower) quality check"
2222
@echo " clean clean up build and generated files"
2323
@echo " distclean clean up build and generated files, including project metadata files"

0 commit comments

Comments
 (0)