Move to explicitly creating a new loop (#3164)

[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 3dc26b7013f4f5e1fba09db3497a11c0f97c07c3..7f76c57d3e622d48cd4b021fce25e9e02353c115 100644 (file)
--- a/docs/usage_and_configuration/the_basics.md
+++ b/docs/usage_and_configuration/the_basics.md
@@ -4,11 +4,11 @@ Foundational knowledge on using and configuring Black.
 
 _Black_ is a well-behaved Unix-style command-line tool:
 
 
 _Black_ is a well-behaved Unix-style command-line tool:
 

-- it does nothing if no sources are passed to it;
+- it does nothing if it finds no sources to format;

 - it will read from standard input and write to standard output if `-` is used as the
   filename;
 - it only outputs messages to users on standard error;
 - it will read from standard input and write to standard output if `-` is used as the
   filename;
 - it only outputs messages to users on standard error;

-- exits with code 0 unless an internal error occurred (or `--check` was used).
+- exits with code 0 unless an internal error occurred or a CLI option prompted it.

 
 ## Usage
 
 
 ## Usage
 


@@ -26,13 +26,13 @@ python -m black {source_file_or_directory}
 
 ### Command line options
 
 
 ### Command line options
 

-_Black_ has quite a few knobs these days, although _Black_ is opinionated so style
-configuration options are deliberately limited and rarely added. You can list them by
-running `black --help`.
+The CLI options of _Black_ can be displayed by expanding the view below or by running
+`black --help`. While _Black_ has quite a few knobs these days, it is still opinionated
+so style options are deliberately limited and rarely added.

 
 <details>
 
 
 <details>
 

-<summary>Help output</summary>
+<summary>CLI reference</summary>

 
 ```{program-output} black --help
 
 
 ```{program-output} black --help
 


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

-black, version 21.11b1
+black, version 22.6.0

 ```
 
 An option to require a specific version to be running is also provided.
 ```
 
 An option to require a specific version to be running is also provided.


@@ -259,10 +259,14 @@ expressions by Black. Use `[ ]` to denote a significant space character.
 line-length = 88
 target-version = ['py37']
 include = '\.pyi?$'
 line-length = 88
 target-version = ['py37']
 include = '\.pyi?$'

+# 'extend-exclude' excludes files or directories in addition to the defaults

 extend-exclude = '''
 # A regex preceded with ^/ will apply only to files and directories
 # in the root of the project.
 extend-exclude = '''
 # A regex preceded with ^/ will apply only to files and directories
 # in the root of the project.

-^/foo.py  # exclude a file named foo.py in the root of the project (in addition to the defaults)
+(
+  ^/foo.py    # exclude a file named foo.py in the root of the project
+  | *_pb2.py  # exclude autogenerated Protocol Buffer files anywhere in the project
+)

 '''
 ```
 
 '''
 ```