Skip to content

Commit 6596f7f

Browse files
committed
misc doc fixes
1 parent 737d48f commit 6596f7f

File tree

3 files changed

+8
-3
lines changed

3 files changed

+8
-3
lines changed

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ env/
1212
build/
1313
dist/
1414
*.prof
15+
*.egg-info
1516
# Generated
1617
**/gen/*.py
1718
!**/gen/*.pyi
@@ -23,5 +24,4 @@ dist/
2324
*.spec
2425

2526
# Dev settings
26-
*.pkl
2727
settings.toml

docs/CONTRIBUTING.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,11 @@ If you like to use pre-commit hooks, `.pre-commit-config.yaml` is setup for such
1616

1717
The CI will automatically fix and commit any autofixable issue your changes may have.
1818

19+
## Visual Designer
20+
21+
If you need to make visual changes, run `./scripts/designer.ps1` to quickly open the bundled Qt Designer.
22+
(Can also be downloaded externally as a non-python package)
23+
1924
## Pull Request Guidelines
2025

2126
If your pull request is meant to address an open issue, please link it as part of your Pull Request description. If it would close said issue, please use a [closing keyword](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword).

scripts/lint.ps1

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ $originalDirectory = $pwd
22
Set-Location "$PSScriptRoot/.."
33
$exitCodes = 0
44

5-
Write-Host "`nRunning Ruff ..."
5+
Write-Host "`nRunning Ruff check ..."
66
ruff check --fix
77
$exitCodes += $LastExitCode
88
if ($LastExitCode -gt 0) {
@@ -12,7 +12,7 @@ else {
1212
Write-Host "`Ruff passed" -ForegroundColor Green
1313
}
1414

15-
Write-Host "`nRunning formatting..."
15+
Write-Host "`nRunning Ruff format ..."
1616
ruff format
1717

1818
$pyrightVersion = 'latest' # Change this if latest has issues

0 commit comments

Comments
 (0)