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

README updates (#235)

Browse Source 
* Consistent titles in 'Sentence case'
* Add console Markdown formatting
* Fix macOS typos
* Fix Homebrew typo
This commit is contained in:
Hugo 2018-05-20 19:50:41 +03:00 committed by Łukasz Langa
parent c891c65b6b
commit 34646945e7
1 changed files with 15 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -27,7 +27,7 @@ content instead.
possible. possible.
## Installation and Usage ## Installation and usage
### Installation ### Installation
@ -301,7 +301,7 @@ key. My recommendation here is to keep using whatever is faster to type
and let *Black* handle the transformation. and let *Black* handle the transformation.
### Line Breaks & Binary Operators ### Line breaks & binary operators
*Black* will break a line before a binary operator when splitting a block *Black* will break a line before a binary operator when splitting a block
of code over multiple lines. This is so that *Black* is compliant with the of code over multiple lines. This is so that *Black* is compliant with the
@ -431,19 +431,25 @@ Use [proofit404/blacken](https://github.com/proofit404/blacken).
1. Install `black`. 1. Install `black`.
$ pip install black ```console
$ pip install black
```
2. Locate your `black` installation folder. 2. Locate your `black` installation folder.
On MacOS / Linux / BSD: On macOS / Linux / BSD:
$ which black ```console
/usr/local/bin/black # possible location $ which black
/usr/local/bin/black # possible location
```
On Windows: On Windows:
$ where black ```console
%LocalAppData%\Programs\Python\Python36-32\Scripts\black.exe # possible location $ where black
%LocalAppData%\Programs\Python\Python36-32\Scripts\black.exe # possible location
```
3. Open External tools in PyCharm with `File -> Settings -> Tools -> External Tools`. 3. Open External tools in PyCharm with `File -> Settings -> Tools -> External Tools`.
@ -502,7 +508,7 @@ The plugin will use it.
**How to get Vim with Python 3.6?** **How to get Vim with Python 3.6?**
On Ubuntu 17.10 Vim comes with Python 3.6 by default. On Ubuntu 17.10 Vim comes with Python 3.6 by default.
On macOS with HomeBrew run: `brew install vim --with-python3`. On macOS with Homebrew run: `brew install vim --with-python3`.
When building Vim from source, use: When building Vim from source, use:
`./configure --enable-python3interp=yes`. There's many guides online how `./configure --enable-python3interp=yes`. There's many guides online how
to do this. to do this.