added the py311 to target-version config (#3898)

[etc/vim.git] / docs / usage_and_configuration / the_basics.md

diff --git a/docs/usage_and_configuration/the_basics.md b/docs/usage_and_configuration/the_basics.md
index 6f3a3cff30c58f6ccbdb6c3df29a61ef20e34256..36119f225e6a31ce25ea11422e1c2a649d6bf678 100644 (file)
--- a/docs/usage_and_configuration/the_basics.md
+++ b/docs/usage_and_configuration/the_basics.md
@@ -52,18 +52,19 @@ See also [the style documentation](labels/line-length).
 
 #### `-t`, `--target-version`
 
 
 #### `-t`, `--target-version`
 

-Python versions that should be supported by Black's output. You should include all
-versions that your code supports. If you support Python 3.7 through 3.10, you should
-write:
+Python versions that should be supported by Black's output. You can run `black --help`
+and look for the `--target-version` option to see the full list of supported versions.
+You should include all versions that your code supports. If you support Python 3.8
+through 3.11, you should write:

 
 ```console
 
 ```console

-$ black -t py37 -t py38 -t py39 -t py310
+$ black -t py38 -t py39 -t py310 -t py311

 ```
 
 In a [configuration file](#configuration-via-a-file), you can write:
 
 ```toml
 ```
 
 In a [configuration file](#configuration-via-a-file), you can write:
 
 ```toml

-target-versions = ["py37", "py38", "py39", "py310"]
+target-version = ["py38", "py39", "py310", "py311"]

 ```
 
 _Black_ uses this option to decide what grammar to use to parse your code. In addition,
 ```
 
 _Black_ uses this option to decide what grammar to use to parse your code. In addition,


@@ -193,8 +194,8 @@ configuration file for consistent results across environments.
 
 ```console
 $ black --version
 
 ```console
 $ black --version

-black, 23.3.0 (compiled: yes)
-$ black --required-version 23.3.0 -c "format = 'this'"
+black, 23.9.1 (compiled: yes)
+$ black --required-version 23.9.1 -c "format = 'this'"

 format = "this"
 $ black --required-version 31.5b2 -c "still = 'beta?!'"
 Oh no! 💥 💔 💥 The required version does not match the running version!
 format = "this"
 $ black --required-version 31.5b2 -c "still = 'beta?!'"
 Oh no! 💥 💔 💥 The required version does not match the running version!


@@ -246,7 +247,8 @@ respect the `--force-exclude` option on some editors that rely on using stdin.
 #### `-W`, `--workers`
 
 When _Black_ formats multiple files, it may use a process pool to speed up formatting.
 #### `-W`, `--workers`
 
 When _Black_ formats multiple files, it may use a process pool to speed up formatting.

-This option controls the number of parallel workers.
+This option controls the number of parallel workers. This can also be specified via the
+`BLACK_NUM_WORKERS` environment variable.

 
 #### `-q`, `--quiet`
 
 
 #### `-q`, `--quiet`
 


@@ -284,7 +286,7 @@ You can check the version of _Black_ you have installed using the `--version` fl
 
 ```console
 $ black --version
 
 ```console
 $ black --version

-black, 23.3.0
+black, 23.9.1

 ```
 
 #### `--config`
 ```
 
 #### `--config`


@@ -296,6 +298,19 @@ Read configuration options from a configuration file. See
 
 Show available command-line options and exit.
 
 
 Show available command-line options and exit.
 

+### Environment variable options
+
+_Black_ supports the following configuration via environment variables.
+
+#### `BLACK_CACHE_DIR`
+
+The directory where _Black_ should store its cache.
+
+#### `BLACK_NUM_WORKERS`
+
+The number of parallel workers _Black_ should use. The command line option `-W` /
+`--workers` takes precedence over this environment variable.
+

 ### Code input alternatives
 
 _Black_ supports formatting code via stdin, with the result being printed to stdout.
 ### Code input alternatives
 
 _Black_ supports formatting code via stdin, with the result being printed to stdout.