Skip to content

Commit

Permalink
remove black formatter
Browse files Browse the repository at this point in the history
  • Loading branch information
jeffjennings committed Jul 29, 2024
1 parent 5c21bfb commit 417ca7b
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 7 deletions.
5 changes: 1 addition & 4 deletions .github/workflows/format_lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,7 @@ jobs:
pip install .[coding_standards]
- name: Install package
run: pip install .

- name: Run `black` formatter
run: black .
run: pip install .

- name: Run `ruff` linter / formatter
run: ruff check .
4 changes: 2 additions & 2 deletions docs/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Repo file structure
| * `ISSUE_TEMPLATE` has files that are templates users can select from when opening an issue in the repo on GitHub
| * `workflows` implements continuous integration (CI) through GitHub 'actions' that are automatically run according to a chosen trigger. These are currently:
| - `docs.yml` builds and deploys this docs site when a push is made to `main`.
| - `format_lint.yml` lints and formats the code on each push using *ruff* and *black*.
| - `format_lint.yml` lints and formats the code on each push using *ruff*.
| - `package.yml` releases the package to PyPI on each *release* (create a release from the repo's main GitHub page). This makes the latest release version of the package *pip*-installable. For a guide on how to first reserve a name for your project on PyPI (necessary for this workflow), see the `Python packaging guide <https://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/>`_.
| - `tests.yml` runs tests with *pytest* on each push.
| - `type_check.yml` runs type checking with *mypy* on each push. The CI continues even if the type checker finds errors.
Expand Down Expand Up @@ -38,7 +38,7 @@ Interacting with your new code
| 2) Run your tests:
| `pytest .`
| 3) Run linting and formatting to see their effects:
| `black .` and `ruff check .`
| `ruff check .`
| 4) Run type checking using mypy:
| `mypy --strict .`
| 5) Build your docs locally:
Expand Down
1 change: 0 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ docs = [
"ipykernel",
]
coding_standards = [
"black",
"ruff",
]
type_checking = [
Expand Down

0 comments on commit 417ca7b

Please sign in to comment.