Improve handling of root to get_sources (#3847)

[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 1ca6161bf0bd128f2763cbb6babd71d3bb979a34..24e732848f1487b96b4e21d6750a01b5529ff383 100644 (file)
--- a/docs/integrations/source_version_control.md
+++ b/docs/integrations/source_version_control.md
@@ -6,9 +6,48 @@ Use [pre-commit](https://pre-commit.com/). Once you
 
 ```yaml
 repos:
 
 ```yaml
 repos:

-  - repo: https://github.com/psf/black
-    rev: stable # Replace by any tag/version: https://github.com/psf/black/tags
+  # Using this mirror lets us use mypyc-compiled black, which is about 2x faster
+  - repo: https://github.com/psf/black-pre-commit-mirror
+    rev: 23.7.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 a different version of Black.
+
+Note if you'd like to use a specific commit in `rev`, you'll need to swap the repo
+specified from the mirror to https://github.com/psf/black. 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].
+
+## 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:
+  # Using this mirror lets us use mypyc-compiled black, which is about 2x faster
+  - repo: https://github.com/psf/black-pre-commit-mirror
+    rev: 23.7.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.
+```
+
+[pre-commit-mutable-rev]:
+  https://pre-commit.com/#using-the-latest-version-for-a-repository