Make black remove leading and trailing spaces from one-line docstrings (#1740)

[etc/vim.git] / docs / editor_integration.md

diff --git a/docs/editor_integration.md b/docs/editor_integration.md
index bc7c2e7b7be283c9e29c98e239f89d32ce5ea520..f2d21f211139eb2ca57f0a018bee452968250c4a 100644 (file)
--- a/docs/editor_integration.md
+++ b/docs/editor_integration.md
@@ -12,38 +12,38 @@ Options include the following:
 
 1. Install `black`.
 
 
 1. Install `black`.
 

-```console
-$ 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:

 
 

-```console
-$ which black
-/usr/local/bin/black  # possible location
-```
+   ```console
+   $ which black
+   /usr/local/bin/black  # possible location
+   ```

 
 

-On Windows:
+   On Windows:

 
 

-```console
-$ where black
-%LocalAppData%\Programs\Python\Python36-32\Scripts\black.exe  # possible location
-```
+   ```console
+   $ where black
+   %LocalAppData%\Programs\Python\Python36-32\Scripts\black.exe  # possible location
+   ```

 
 

-Note that if you are using a virtual environment detected by PyCharm, this is an
-unneeded step. In this case the path to `black` is `$PyInterpreterDirectory$/black`.
+   Note that if you are using a virtual environment detected by PyCharm, this is an
+   unneeded step. In this case the path to `black` is `$PyInterpreterDirectory$/black`.

 
 3. Open External tools in PyCharm/IntelliJ IDEA
 
 
 3. Open External tools in PyCharm/IntelliJ IDEA
 

-On macOS:
+   On macOS:

 
 

-`PyCharm -> Preferences -> Tools -> External Tools`
+   `PyCharm -> Preferences -> Tools -> External Tools`

 
 

-On Windows / Linux / BSD:
+   On Windows / Linux / BSD:

 
 

-`File -> Settings -> Tools -> External Tools`
+   `File -> Settings -> Tools -> External Tools`

 
 4. Click the + icon to add a new external tool with the following values:
 
 
 4. Click the + icon to add a new external tool with the following values:
 


@@ -83,34 +83,36 @@ Wing supports black via the OS Commands tool, as explained in the Wing documenta
 
 1. Install `black`.
 
 
 1. Install `black`.
 

-```console
-$ pip install black
-```
+   ```console
+   $ pip install black
+   ```

 
 2. Make sure it runs from the command line, e.g.
 
 
 2. Make sure it runs from the command line, e.g.
 

-```console
-$ black --help
-```
+   ```console
+   $ black --help
+   ```

 
 3. In Wing IDE, activate the **OS Commands** panel and define the command **black** to
    execute black on the currently selected file:
 
 
 3. In Wing IDE, activate the **OS Commands** panel and define the command **black** to
    execute black on the currently selected file:
 

-- Use the Tools -> OS Commands menu selection
-- click on **+** in **OS Commands** -> New: Command line..
-  - Title: black
-  - Command Line: black %s
-  - I/O Encoding: Use Default
-  - Key Binding: F1
-  - [x] Raise OS Commands when executed
-  - [x] Auto-save files before execution
-  - [x] Line mode
+   - Use the Tools -> OS Commands menu selection
+   - click on **+** in **OS Commands** -> New: Command line..
+     - Title: black
+     - Command Line: black %s
+     - I/O Encoding: Use Default
+     - Key Binding: F1
+     - [x] Raise OS Commands when executed
+     - [x] Auto-save files before execution
+     - [x] Line mode

 
 4. Select a file in the editor and press **F1** , or whatever key binding you selected
    in step 3, to reformat the file.
 
 ## Vim
 
 
 4. Select a file in the editor and press **F1** , or whatever key binding you selected
    in step 3, to reformat the file.
 
 ## Vim
 

+### Official plugin
+

 Commands and shortcuts:
 
 - `:Black` to format the entire file (ranges not supported);
 Commands and shortcuts:
 
 - `:Black` to format the entire file (ranges not supported);


@@ -233,6 +235,17 @@ If you later want to update _Black_, you should do it like this:
 $ pip install -U black --no-binary regex,typed-ast
 ```
 
 $ pip install -U black --no-binary regex,typed-ast
 ```
 

+### With ALE
+
+1. Install [`ale`](https://github.com/dense-analysis/ale)
+2. Install `black`
+3. Add this to your vimrc:
+
+   ```vim
+   let g:ale_fixers = {}
+   let g:ale_fixers.python = ['black']
+   ```
+

 ## Gedit
 
 gedit is the default text editor of the GNOME, Unix like Operating Systems. Open gedit
 ## Gedit
 
 gedit is the default text editor of the GNOME, Unix like Operating Systems. Open gedit