From 6d8d90011200bc13b1385374596db96233295a05 Mon Sep 17 00:00:00 2001 From: Peter Corke Date: Fri, 20 Nov 2026 07:38:50 +1000 Subject: [PATCH] docs: remove black from CONTRIBUTING, it is no longer configured Co-Authored-By: Claude Sonnet 5.5 --- .github/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 61feb42f..6654c28b 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -18,7 +18,7 @@ Issues labelled [`good first issue`](https://github.com/petercorke/machinevision - Keep pull requests scoped to a single feature or fix. If you have several unrelated changes, open separate PRs so each can be reviewed and merged independently. - For API changes, propose the change in [Discussions](https://github.com/petercorke/machinevision-toolbox-python/discussions) before opening a PR. - PR titles follow [Conventional Commits](https://www.conventionalcommits.org/) (`type: description`) — checked automatically on the PR. -- Code is linted and import-sorted with [ruff](https://docs.astral.sh/ruff/) and formatted with [black](https://pypi.org/project/black/); configuration is in `pyproject.toml` under `[tool.ruff]` and `[tool.black]`. Type checking is done with [pyright](https://microsoft.github.io/pyright/) (`[tool.pyright]`). +- Code is linted and import-sorted with [ruff](https://docs.astral.sh/ruff/); configuration is in `pyproject.toml` under `[tool.ruff]`. Type checking is done with [pyright](https://microsoft.github.io/pyright/) (`[tool.pyright]`). - New or changed code should be type-hinted using modern syntax (`X | Y`, `X | None`, `list[X]`, `dict[K, V]` — not `Union`, `Optional`, `List`, `Dict`). - Docstrings use reST style (`:param:`, `:returns:`). Type hints in the function signature already cover types, so `:type:`/`:rtype:` are rarely needed. - Any code change should be covered by tests and must not break existing ones. Tests live in `tests/`. Install the dev dependencies with `pip install -e '.[dev]'` (add `,docs` too if you're touching documentation), then run: