Don't omit whitespace when the factor is not a math operator

[etc/vim.git] / README.md

diff --git a/README.md b/README.md
index b7c6229214fc55549aedd8c46d750d2795998a8a..aba30ab2fb0483483e75bb32f28d7bd6185ae2ca 100644 (file)
--- a/README.md
+++ b/README.md
@@ -54,6 +54,12 @@ Options:
   --help                      Show this message and exit.
 ```
 
   --help                      Show this message and exit.
 ```
 

+`Black` is a well-behaved Unix-style command-line tool:
+* it does nothing if no sources are passed to it;
+* 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.
+

 
 ## The philosophy behind *Black*
 
 
 ## The philosophy behind *Black*
 


@@ -76,12 +82,14 @@ or simple statement per line.  If this fits the allotted line length,
 great.
 ```py3
 # in:
 great.
 ```py3
 # in:

+

 l = [1,
      2,
      3,
 ]
 
 # out:
 l = [1,
      2,
      3,
 ]
 
 # out:

+

 l = [1, 2, 3]
 ```
 
 l = [1, 2, 3]
 ```
 


@@ -89,9 +97,11 @@ If not, *Black* will look at the contents of the first outer matching
 brackets and put that in a separate indented line.
 ```py3
 # in:
 brackets and put that in a separate indented line.
 ```py3
 # in:

+

 l = [[n for n in list_bosses()], [n for n in list_employees()]]
 
 # out:
 l = [[n for n in list_bosses()], [n for n in list_employees()]]
 
 # out:

+

 l = [
     [n for n in list_bosses()], [n for n in list_employees()]
 ]
 l = [
     [n for n in list_bosses()], [n for n in list_employees()]
 ]


@@ -106,12 +116,14 @@ matching brackets.  If that doesn't work, it will put all of them in
 separate lines.
 ```py3
 # in:
 separate lines.
 ```py3
 # in:

+

 def very_important_function(template: str, *variables, file: os.PathLike, debug: bool = False):
     """Applies `variables` to the `template` and writes to `file`."""
     with open(file, 'w') as f:
         ...
 
 # out:
 def very_important_function(template: str, *variables, file: os.PathLike, debug: bool = False):
     """Applies `variables` to the `template` and writes to `file`."""
     with open(file, 'w') as f:
         ...
 
 # out:

+

 def very_important_function(
     template: str,
     *variables,
 def very_important_function(
     template: str,
     *variables,


@@ -201,7 +213,15 @@ body.
 
 ### Editor integration
 
 
 ### Editor integration
 

-There is currently no integration with any text editors. Vim and
+* Visual Studio Code: [joslarson.black-vscode](https://marketplace.visualstudio.com/items?itemName=joslarson.black-vscode)
+
+Any tool that can pipe code through *Black* using its stdio mode (just
+[use `-` as the file name](http://www.tldp.org/LDP/abs/html/special-chars.html#DASHREF2)).
+The formatted code will be returned on stdout (unless `--check` was
+passed).  *Black* will still emit messages on stderr but that shouldn't
+affect your use case.
+
+There is currently no integration with any other text editors. Vim and

 Atom/Nuclide integration is planned by the author, others will require
 external contributions.
 
 Atom/Nuclide integration is planned by the author, others will require
 external contributions.
 


@@ -273,6 +293,11 @@ More details can be found in [CONTRIBUTING](CONTRIBUTING.md).
 
 ## Change Log
 
 
 ## Change Log
 

+### 18.3a4 (unreleased)
+
+* don't omit whitespace if the previous factor leaf wasn't a math
+  operator (#55)
+

 ### 18.3a3
 
 * don't remove single empty lines outside of bracketed expressions
 ### 18.3a3
 
 * don't remove single empty lines outside of bracketed expressions