actions/black
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Consistent empty lines in the README

Browse Source
This commit is contained in:
Łukasz Langa 2018-05-16 19:35:46 -07:00
parent e94bda11c3
commit dafa12f10b
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -268,6 +268,7 @@ if you'd like a trailing comma in this situation and *Black* didn't
recognize it was safe to do so, put it there manually and *Black* will
keep it.
### Strings
*Black* prefers double quotes (`"` and `"""`) over single quotes (`'`
@ -297,6 +298,7 @@ a bit easier than double quotes. The latter requires use of the Shift
key. My recommendation here is to keep using whatever is faster to type
and let *Black* handle the transformation.
### Line Breaks & Binary Operators
*Black* will break a line before a binary operator when splitting a block
@ -308,6 +310,7 @@ 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.
### Slices
PEP 8 [recommends](https://www.python.org/dev/peps/pep-0008/#whitespace-in-expressions-and-statements)
@ -321,6 +324,7 @@ This behaviour may raise ``E203 whitespace before ':'`` warnings in style guide
enforcement tools like Flake8. Since ``E203`` 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
@ -354,6 +358,7 @@ return not (this or that)
decision = (maybe.this() and values > 0) or (maybe.that() and values < 0)
```
### Call chains
Some popular APIs, like ORMs, use call chaining. This API style is known
@ -374,6 +379,7 @@ def example(session):
)
```
### Typing stub files
PEP 484 describes the syntax for type hints in Python. One of the
@ -504,14 +510,17 @@ to do this.
Use [joslarson.black-vscode](https://marketplace.visualstudio.com/items?itemName=joslarson.black-vscode).
### SublimeText 3
Use [sublack plugin](https://github.com/jgirardet/sublack).
### IPython Notebook Magic
Use [blackcellmagic](https://github.com/csurfer/blackcellmagic).
### Other editors
Atom/Nuclide integration is planned by the author, others will