Set `is_pyi` if `stdin_filename` ends with `.pyi` (#2169)

[etc/vim.git] / README.md

diff --git a/README.md b/README.md
index 411a8c8609d0a51589686be497b2c69d4a5665f3..41cea761df564c4efb9ca60d323deb5d6073ac9b 100644 (file)
--- a/README.md
+++ b/README.md
@@ -50,7 +50,8 @@ _Contents:_ **[Installation and usage](#installation-and-usage)** |
 ### Installation
 
 _Black_ can be installed by running `pip install black`. It requires Python 3.6.2+ to
 ### Installation
 
 _Black_ can be installed by running `pip install black`. It requires Python 3.6.2+ to

-run but you can reformat Python 2 code with it, too.
+run. If you want to format Python 2 code as well, install with
+`pip install black[python2]`.

 
 #### Install from GitHub
 
 
 #### Install from GitHub
 


@@ -102,8 +103,8 @@ Options:
                                   split lines.
 
   --check                         Don't write the files back, just return the
                                   split lines.
 
   --check                         Don't write the files back, just return the

-                                  status.  Return code 0 means nothing would
-                                  change.  Return code 1 means some files
+                                  status. Return code 0 means nothing would
+                                  change. Return code 1 means some files

                                   would be reformatted. Return code 123 means
                                   there was an internal error.
 
                                   would be reformatted. Return code 123 means
                                   there was an internal error.
 


@@ -118,22 +119,22 @@ Options:
 
   --include TEXT                  A regular expression that matches files and
                                   directories that should be included on
 
   --include TEXT                  A regular expression that matches files and
                                   directories that should be included on

-                                  recursive searches.  An empty value means
+                                  recursive searches. An empty value means

                                   all files are included regardless of the
                                   all files are included regardless of the

-                                  name.  Use forward slashes for directories
-                                  on all platforms (Windows, too).  Exclusions
+                                  name. Use forward slashes for directories
+                                  on all platforms (Windows, too). Exclusions

                                   are calculated first, inclusions later.
                                   [default: \.pyi?$]
 
   --exclude TEXT                  A regular expression that matches files and
                                   directories that should be excluded on
                                   are calculated first, inclusions later.
                                   [default: \.pyi?$]
 
   --exclude TEXT                  A regular expression that matches files and
                                   directories that should be excluded on

-                                  recursive searches.  An empty value means no
+                                  recursive searches. An empty value means no

                                   paths are excluded. Use forward slashes for
                                   directories on all platforms (Windows, too).
                                   Exclusions are calculated first, inclusions
                                   paths are excluded. Use forward slashes for
                                   directories on all platforms (Windows, too).
                                   Exclusions are calculated first, inclusions

-                                  later.  [default: /(\.direnv|\.eggs|\.git|\.
-                                  hg|\.mypy_cache|\.nox|\.tox|\.venv|\.svn|_bu
-                                  ild|buck-out|build|dist)/]
+                                  later. [default: /(\.direnv|\.eggs|\.git|\.
+                                  hg|\.mypy_cache|\.nox|\.tox|\.venv|venv|\.sv
+                                  n|_build|buck-out|build|dist)/]

 
   --extend-exclude TEXT           Like --exclude, but adds additional files
                                   and directories on top of the excluded
 
   --extend-exclude TEXT           Like --exclude, but adds additional files
                                   and directories on top of the excluded


@@ -236,9 +237,11 @@ is that **until the formatter becomes stable, you should expect some formatting
 change in the future**. That being said, no drastic stylistic changes are planned,
 mostly responses to bug reports.
 
 change in the future**. That being said, no drastic stylistic changes are planned,
 mostly responses to bug reports.
 

-Also, as a temporary safety measure, _Black_ will check that the reformatted code still
-produces a valid AST that is equivalent to the original. This slows it down. If you're
-feeling confident, use `--fast`.
+Also, as a safety measure which slows down processing, _Black_ will check that the
+reformatted code still produces a valid AST that is effectively equivalent to the
+original (see the
+[Pragmatism](https://github.com/psf/black/blob/master/docs/the_black_code_style.md#pragmatism)
+section for details). If you're feeling confident, use `--fast`.

 
 ## The _Black_ code style
 
 
 ## The _Black_ code style
 


@@ -292,6 +295,20 @@ parent directories. It stops looking when it finds the file, or a `.git` directo
 If you're formatting standard input, _Black_ will look for configuration starting from
 the current working directory.
 
 If you're formatting standard input, _Black_ will look for configuration starting from
 the current working directory.
 

+You can use a "global" configuration, stored in a specific location in your home
+directory. This will be used as a fallback configuration, that is, it will be used if
+and only if _Black_ doesn't find any configuration as mentioned above. Depending on your
+operating system, this configuration file should be stored as:
+
+- Windows: `~\.black`
+- Unix-like (Linux, MacOS, etc.): `$XDG_CONFIG_HOME/black` (`~/.config/black` if the
+  `XDG_CONFIG_HOME` environment variable is not set)
+
+Note that these are paths to the TOML file itself (meaning that they shouldn't be named
+as `pyproject.toml`), not directories where you store the configuration. Here, `~`
+refers to the path to your home directory. On Windows, this will be something like
+`C:\\Users\UserName`.
+

 You can also explicitly specify the path to a particular file that you want with
 `--config`. In this situation _Black_ will not look for any other file.
 
 You can also explicitly specify the path to a particular file that you want with
 `--config`. In this situation _Black_ will not look for any other file.
 


@@ -524,8 +541,8 @@ Maintained with [Carol Willing](mailto:carolcode@willingconsulting.com),
 [Carl Meyer](mailto:carl@oddbird.net),
 [Jelle Zijlstra](mailto:jelle.zijlstra@gmail.com),
 [Mika Naylor](mailto:mail@autophagy.io),
 [Carl Meyer](mailto:carl@oddbird.net),
 [Jelle Zijlstra](mailto:jelle.zijlstra@gmail.com),
 [Mika Naylor](mailto:mail@autophagy.io),

-[Zsolt Dollenstein](mailto:zsol.zsol@gmail.com), and
-[Cooper Lees](mailto:me@cooperlees.com).
+[Zsolt Dollenstein](mailto:zsol.zsol@gmail.com),
+[Cooper Lees](mailto:me@cooperlees.com), and Richard Si.

 
 Multiple contributions by:
 
 
 Multiple contributions by: