Docs: clarify fmt:on/off requirements (#2985) (#3048)

[etc/vim.git] / README.md

diff --git a/README.md b/README.md
index f2d06bedad23ecf8de358fd0c67009463a82ac4f..1ffa7ef9522855bb66dad0724c11d57c9fb8b652 100644 (file)
--- a/README.md
+++ b/README.md
@@ -39,7 +39,8 @@ Try it out now using the [Black Playground](https://black.vercel.app). Watch the
 ### Installation
 
 _Black_ can be installed by running `pip install black`. It requires Python 3.6.2+ to
 ### 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:
 
 
 If you can't wait for the latest _hotness_ and want to install from GitHub, use:
 


@@ -69,7 +70,7 @@ tests, and our own auto formatting and parallel Continuous Integration runner. N
 we have become stable, you should not expect large formatting to changes in the future.
 Stylistic changes will mostly be responses to bug reports and support for new Python
 syntax. For more information please refer to the
 we have become stable, you should not expect large formatting to changes in the future.
 Stylistic changes will mostly be responses to bug reports and support for new Python
 syntax. For more information please refer to the

-[The Black Code Style](docs/the_black_code_style/index.rst).
+[The Black Code Style](https://black.readthedocs.io/en/stable/the_black_code_style/index.html).

 
 Also, as a safety measure which slows down processing, _Black_ will check that the
 reformatted code still produces a valid AST that is effectively equivalent to the
 
 Also, as a safety measure which slows down processing, _Black_ will check that the
 reformatted code still produces a valid AST that is effectively equivalent to the