hazza/docker-stacks
1
0
Fork 0
mirror of https://github.com/jupyter/docker-stacks.git synced 2025-10-08 18:44:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve docs about pre-commit and mypy

Browse Source
This commit is contained in:
Ayaz Salikhov
2024-09-14 23:37:52 +03:00
parent 3483dfaed1
commit 9e230b3b7d
2 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
.pre-commit-config.yaml
View File

@@ -51,13 +51,13 @@ repos:
"types-tabulate", "types-tabulate",
"types-urllib3", "types-urllib3",
] ]
# Unfortunately, `pre-commit` only runs on changed files # Unfortunately, `pre-commit` only runs on modified files
# This doesn't work well with `mypy --follow-imports error` # This doesn't work well with `mypy --follow-imports error`
# See: https://github.com/pre-commit/mirrors-mypy/issues/34#issuecomment-1062160321 # See: https://github.com/pre-commit/mirrors-mypy/issues/34#issuecomment-1062160321
# #
# To work around this we run `mypy` only in manual mode # To work around this we run `mypy` only in manual mode
# So it won't run as part of `git commit` command # So it won't run as part of `git commit` command,
# But it will still be run as part of `pre-commit` workflow and give expected results # but it will still be run as part of `pre-commit` workflow and give expected results
stages: [manual] stages: [manual]
# Autoformat: YAML, JSON, Markdown, etc. # Autoformat: YAML, JSON, Markdown, etc.

2
docs/contributing/lint.md
View File

@@ -38,7 +38,7 @@ pre-commit run --all-files --hook-stage manual
``` ```
```{note} ```{note}
We're running `pre-commit` with `--hook-stage manual`, because works with changed files, which doesn't work well for mypy. We're running `pre-commit` with `--hook-stage manual`, because `pre-commit` is run on modified files only, which doesn't work well with `mypy --follow-imports error`.
More information can be found in [`.pre-commit-config.yaml` file](https://github.com/jupyter/docker-stacks/blob/main/.pre-commit-config.yaml) More information can be found in [`.pre-commit-config.yaml` file](https://github.com/jupyter/docker-stacks/blob/main/.pre-commit-config.yaml)
``` ```