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

Mention how stdio handling works

Browse Source 
Fixes #57
This commit is contained in:
Łukasz Langa 2018-03-21 17:37:16 -07:00
parent afff418fa1
commit 79b720ca9f
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -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*
@ -209,6 +215,12 @@ body.
* Visual Studio Code: [joslarson.black-vscode](https://marketplace.visualstudio.com/items?itemName=joslarson.black-vscode) * 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 There is currently no integration with any other text editors. Vim and
Atom/Nuclide integration is planned by the author, others will require Atom/Nuclide integration is planned by the author, others will require
external contributions. external contributions.