Document each configuration option in more detail (#2839)

[etc/vim.git] / docs / integrations / source_version_control.md

diff --git a/docs/integrations/source_version_control.md b/docs/integrations/source_version_control.md
index 220f429eb20d736847b5e7dcea86d9aff0919e82..8b8fd658e0e47776d53936854f4919a63a389c71 100644 (file)
--- a/docs/integrations/source_version_control.md
+++ b/docs/integrations/source_version_control.md
@@ -7,10 +7,14 @@ Use [pre-commit](https://pre-commit.com/). Once you
 ```yaml
 repos:
   - repo: https://github.com/psf/black
 ```yaml
 repos:
   - repo: https://github.com/psf/black

-    rev: 21.8b0
+    rev: 23.3.0

     hooks:
       - id: black
     hooks:
       - id: black

-        language_version: python3 # Should be a command that runs python3.6+
+        # 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

 ```
 
 Feel free to switch out the `rev` value to something else, like another
 ```
 
 Feel free to switch out the `rev` value to something else, like another


@@ -18,9 +22,28 @@ 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].
 
 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` (though note that it's only available from version `21.8b0`
-onwards).
+## 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 became available in version 21.8b0.
+```

 
 [black-tags]: https://github.com/psf/black/tags
 [pre-commit-mutable-rev]:
 
 [black-tags]: https://github.com/psf/black/tags
 [pre-commit-mutable-rev]: