]> git.madduck.net Git - etc/vim.git/blobdiff - README.md

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

projects / etc / vim.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Automatic parentheses management
[etc/vim.git] / README.md
diff --git a/README.md b/README.md
index 5c042159665f7570dedf37233bec2a53e7664e6f..06b732466eb3b305307992f35a23df99cc476956 100644 (file)
--- a/README.md
+++ b/README.md
@@ -300,6 +300,22 @@ This behaviour may raise ``W503 line break before binary operator`` warnings in
 style guide enforcement tools like Flake8. Since ``W503`` is not PEP 8 compliant,
 you should tell Flake8 to ignore these warnings.
 
+### Parentheses
+
+Some parentheses are optional in the Python grammar.  Any expression can
+be wrapped in a pair of parentheses to form an atom.  There are a few
+interesting cases:
+
+- `if (...):`
+- `while (...):`
+- `for (...) in (...):`
+- `assert (...), (...)`
+- `from X import (...)`
+
+In those cases, parentheses are removed when the entire statement fits
+in one line, or if the inner expression doesn't have any delimiters to
+further split on.  Otherwise, the parentheses are always added.
+
 
 ## Editor integration
 
@@ -316,14 +332,16 @@ Use [proofit404/blacken](https://github.com/proofit404/blacken).
 
 2. Locate your `black` installation folder.
 
-        $ which black         # MacOS/Linux
+  On MacOS / Linux / BSD:
+
+        $ which black
         /usr/local/bin/black  # possible location
 
-       <!-->
+  On Windows:
 
-        $ where black         # Windows
+        $ where black
         %LocalAppData%\Programs\Python\Python36-32\Scripts\black.exe  # possible location
-        
+
 3. Open External tools in PyCharm with `File -> Settings -> Tools -> External Tools`.
 
 4. Click the + icon to add a new external tool with the following values:
@@ -477,6 +495,8 @@ More details can be found in [CONTRIBUTING](CONTRIBUTING.md).
 
 * added `--quiet` (#78)
 
+* added automatic parentheses management (#4)
+
 * added [pre-commit](https://pre-commit.com) integration (#103, #104)
 
 * fixed reporting on `--check` with multiple files (#101, #102)
@@ -608,8 +628,9 @@ More details can be found in [CONTRIBUTING](CONTRIBUTING.md).
 Glued together by [Łukasz Langa](mailto:lukasz@langa.pl).
 
 Maintained with [Carol Willing](mailto:carolcode@willingconsulting.com),
-[Carl Meyer](mailto:carl@oddbird.net), and
-[Mika Naylor](mailto:mail@autophagy.io).
+[Carl Meyer](mailto:carl@oddbird.net),
+[Mika Naylor](mailto:mail@autophagy.io), and
+[Zsolt Dollenstein](mailto:zsol.zsol@gmail.com).
 
 Multiple contributions by:
 * [Anthony Sottile](mailto:asottile@umich.edu)
@@ -619,4 +640,3 @@ Multiple contributions by:
 * Hugo van Kemenade
 * [Ivan Katanić](mailto:ivan.katanic@gmail.com)
 * [Osaetin Daniel](mailto:osaetindaniel@gmail.com)
-* [Zsolt Dollenstein](mailto:zsol.zsol@gmail.com)
vim configuration

Legalese

All content available in this repository is copyright © martin f. krafft, unless otherwise noted.

All files and their content are released under the terms of the Artistic Licence 2.0, unless otherwise noted.

The operator of this repository shall not be held liable for offending content in pages linking to or linked from these page, nor does he endorse their content unless stated otherwise.