actions/black
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Document black-jupyter hook (#3650)

Browse Source 
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
This commit is contained in:
James Braza 2023-04-19 03:24:03 -07:00 committed by GitHub
parent 3da7339955
commit 4b76a54815
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 20 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
docs/integrations/source_version_control.md
View File

@ -14,7 +14,7 @@ repos:
# supported by your project here, or alternatively use
# pre-commit's default_language_version, see
# https://pre-commit.com/#top_level-default_language_version
language_version: python3.9
language_version: python3.11
```
Feel free to switch out the `rev` value to something else, like another
@ -22,11 +22,27 @@ Feel free to switch out the `rev` value to something else, like another
branches or other mutable refs since the hook [won't auto update as you may
expect][pre-commit-mutable-rev].
If you want support for Jupyter Notebooks as well, then replace `id: black` with
`id: black-jupyter`.
## Jupyter Notebooks
There is an alternate hook `black-jupyter` that expands the targets of `black` to
include Jupyter Notebooks. To use this hook, simply replace the hook's `id: black` with
`id: black-jupyter` in the `.pre-commit-config.yaml`:
```yaml
repos:
- repo: https://github.com/psf/black
rev: 23.3.0
hooks:
- id: black-jupyter
# It is recommended to specify the latest version of Python
# supported by your project here, or alternatively use
# pre-commit's default_language_version, see
# https://pre-commit.com/#top_level-default_language_version
language_version: python3.11
```
```{note}
The `black-jupyter` hook is only available from version 21.8b0 and onwards.
The `black-jupyter` hook became available in version 21.8b0.
```
[black-tags]: https://github.com/psf/black/tags