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

Quote black[jupyter] and black[d] in installation docs (#3006)

Browse Source 
We just got someone on Discord who was confused because the command as
written caused their shell to try to do command expansion.

Co-authored-by: Richard Si <63936253+ichard26@users.noreply.github.com>
This commit is contained in:
Jelle Zijlstra 2022-04-11 16:25:46 -07:00 committed by GitHub
parent 911b59fb4f
commit 96bd428524
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/getting_started.md
View File

@ -17,7 +17,8 @@ Also, you can try out _Black_ online for minimal fuss on the
## Installation
_Black_ can be installed by running `pip install black`. It requires Python 3.6.2+ to
run. If you want to format Jupyter Notebooks, install with `pip install black[jupyter]`.
run. If you want to format Jupyter Notebooks, install with
`pip install 'black[jupyter]'`.
If you can't wait for the latest _hotness_ and want to install from GitHub, use:

2
docs/usage_and_configuration/black_as_a_server.md
View File

@ -7,7 +7,7 @@ process every time you want to blacken a file.
## Usage
`blackd` is not packaged alongside _Black_ by default because it has additional
dependencies. You will need to execute `pip install black[d]` to install it.
dependencies. You will need to execute `pip install 'black[d]'` to install it.
You can start the server on the default port, binding only to the local interface by
running `blackd`. You will see a single line mentioning the server's version, and the