More support for numpy tuple indexing

[etc/vim.git] / README.md

diff --git a/README.md b/README.md
index b53e560506334a1311db460979c6304813d6a30b..c7d14a0a8b909aa46de7409b554dd1510a9d763d 100644 (file)
--- a/README.md
+++ b/README.md
@@ -43,6 +43,11 @@ black [OPTIONS] [SRC]...
 
 Options:
   -l, --line-length INTEGER   Where to wrap around.  [default: 88]
 
 Options:
   -l, --line-length INTEGER   Where to wrap around.  [default: 88]

+  --check                     Don't write back the files, just return the
+                              status.  Return code 0 means nothing changed.
+                              Return code 1 means some files were reformatted.
+                              Return code 123 means there was an internal
+                              error.

   --fast / --safe             If --fast given, skip temporary sanity checks.
                               [default: --safe]
   --version                   Show the version and exit.
   --fast / --safe             If --fast given, skip temporary sanity checks.
                               [default: --safe]
   --version                   Show the version and exit.


@@ -101,7 +106,7 @@ 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):
+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:
         ...
     """Applies `variables` to the `template` and writes to `file`."""
     with open(file, 'w') as f:
         ...


@@ -110,7 +115,6 @@ def very_important_function(template: str, *variables, *, file: os.PathLike, deb
 def very_important_function(
     template: str,
     *variables,
 def very_important_function(
     template: str,
     *variables,

-    *,

     file: os.PathLike,
     debug: bool = False,
 ):
     file: os.PathLike,
     debug: bool = False,
 ):


@@ -248,13 +252,49 @@ answer is "because I don't like a particular formatting" then you're not
 ready to embrace *Black* yet. Such changes are unlikely to get accepted.
 You can still try but prepare to be disappointed.
 
 ready to embrace *Black* yet. Such changes are unlikely to get accepted.
 You can still try but prepare to be disappointed.
 

+More details can be found in [CONTRIBUTING](CONTRIBUTING.md).
+

 
 ## Change Log
 
 
 ## Change Log
 

+### 18.3a2
+
+* changed positioning of binary operators to occur at beginning of lines
+  instead of at the end, following [a recent change to PEP8](https://github.com/python/peps/commit/c59c4376ad233a62ca4b3a6060c81368bd21e85b)
+  (#21)
+
+* ignore empty bracket pairs while splitting. This avoids very weirdly
+  looking formattings (#34, #35)
+
+* remove a trailing comma if there is a single argument to a call
+
+* if top level functions were separated by a comment, don't put four
+  empty lines after the upper function
+
+* fixed unstable formatting of newlines with imports
+
+* fixed unintentional folding of post scriptum standalone comments
+  into last statement if it was a simple statement (#18, #28)
+
+* fixed missing space in numpy-style array indexing (#33)
+
+* fixed spurious space after star-based unary expressions (#31)
+
+

 ### 18.3a1
 
 ### 18.3a1
 

+* added `--check`
+
+* only put trailing commas in function signatures and calls if it's
+  safe to do so. If the file is Python 3.6+ it's always safe, otherwise
+  only safe if there are no `*args` or `**kwargs` used in the signature
+  or call. (#8)
+

 * fixed invalid spacing of dots in relative imports (#6, #13)
 
 * fixed invalid spacing of dots in relative imports (#6, #13)
 

+* fixed invalid splitting after comma on unpacked variables in for-loops
+  (#23)
+

 * fixed spurious space in parenthesized set expressions (#7)
 
 * fixed spurious space after opening parentheses and in default
 * fixed spurious space in parenthesized set expressions (#7)
 
 * fixed spurious space after opening parentheses and in default