Skip to content

Commit abc4ecd

Browse files
chore(dev): add check.ps1 for Windows (#459)
Update docs as well.
1 parent c20d199 commit abc4ecd

2 files changed

Lines changed: 12 additions & 1 deletion

File tree

check.ps1

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
#
2+
# Small script to ensure quality checks pass before submitting a commit/PR.
3+
#
4+
$ErrorActionPreference = "Stop"
5+
6+
python -m ruff format docs src
7+
python -m ruff check --fix --unsafe-fixes docs src
8+
9+
# "--platform win32" to not fail on ctypes.windll (it does not affect the overall check on other OSes)
10+
python -m mypy --platform win32 src docs/source/examples

docs/source/developers.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,8 @@ Code Quality
4040
To ensure the code quality is correct enough::
4141

4242
$ python -m pip install -e '.[dev]'
43-
$ ./check.sh
43+
$ ./check.sh # Linux/macOS
44+
$ .\check.ps1 # Windows (PowerShell)
4445

4546

4647
Documentation

0 commit comments

Comments
 (0)