Skip to content

Commit

Permalink
Document black-jupyter hook (#3650)
Browse files Browse the repository at this point in the history
Co-authored-by: Jelle Zijlstra <[email protected]>
  • Loading branch information
jamesbraza and JelleZijlstra authored Apr 19, 2023
1 parent 3da7339 commit 4b76a54
Showing 1 changed file with 20 additions and 4 deletions.
24 changes: 20 additions & 4 deletions docs/integrations/source_version_control.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,19 +14,35 @@ 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
[tag/version][black-tags] or even a specific commit. Although we discourage the use of
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
Expand Down

0 comments on commit 4b76a54

Please sign in to comment.