README update and code quality checks (#2202)

* README updates.
* Ensure pre-commit black args match those in Makefile.
* Ensure pre-commit and requirements versions align, and the commands run are the same in pre-commit and Makefile.
* Update README files to reflect recent changes. Where possible, remove duplication and point to the official docs.
* Run format and pre-commit prettifier on code.
* Remove isort - it causes more trouble than is justified.
* Ensure usage examples in the README.
This commit is contained in:
Nicholas Tollervey
2024-10-02 13:48:48 +01:00
committed by GitHub
parent 6fab9a1c26
commit af06bc4826
6 changed files with 325 additions and 255 deletions

View File

@@ -28,7 +28,7 @@ repos:
rev: 24.8.0
hooks:
- id: black
exclude: core/src/stdlib/pyscript/__init__\.py
args: ["-l", "88", "--skip-string-normalization"]
- repo: https://github.com/codespell-project/codespell
rev: v2.3.0
@@ -44,10 +44,3 @@ repos:
- id: prettier
exclude: core/test|core/dist|core/types|core/src/stdlib/pyscript.js|pyscript\.sw/|core/src/3rd-party
args: [--tab-width, "4"]
- repo: https://github.com/pycqa/isort
rev: 5.13.2
hooks:
- id: isort
name: isort (python)
args: [--profile, black]