Allow g:flake8_cmd with parameters

[etc/vim.git] / README.mdown

diff --git a/README.mdown b/README.mdown
index e1872e50e3fbb03252e5480d512a782705c4b37a..00d495151d7660cf02075967d5d18c110ffe7db0 100644 (file)
--- a/README.mdown
+++ b/README.mdown
@@ -41,7 +41,7 @@ the `<F7>` key if so.  For example, to remap it to `<F3>` instead, use:
 
 For flake8 configuration options please consult the following page:
 
 
 For flake8 configuration options please consult the following page:
 

-https://flake8.readthedocs.org/en/latest/config.html
+http://flake8.pycqa.org/en/latest/user/configuration.html

 
 To customize the location of your flake8 binary, set `g:flake8_cmd`:
 
 
 To customize the location of your flake8 binary, set `g:flake8_cmd`:
 


@@ -51,6 +51,10 @@ To customize the location of quick fix window, set `g:flake8_quickfix_location`:
 
     let g:flake8_quickfix_location="topleft"
 
 
     let g:flake8_quickfix_location="topleft"
 

+To customize the height of quick fix window, set `g:flake8_quickfix_height`:
+
+    let g:flake8_quickfix_height=7
+

 To customize whether the quickfix window opens, set `g:flake8_show_quickfix`:
 
     let g:flake8_show_quickfix=0  " don't show
 To customize whether the quickfix window opens, set `g:flake8_show_quickfix`:
 
     let g:flake8_show_quickfix=0  " don't show


@@ -104,10 +108,33 @@ This plugin goes well together with the following plugin:
   and `<F9>`)
 
 
   and `<F9>`)
 
 

+Max line lengths
+----------------
+
+One particular customization a lot of people like to make is relaxing the
+maximum line length default.  This is a config setting that should be set in
+flake8 itself. (vim-flake8 "just" invokes it and deals with showing the output
+in Vim's quickfix window.)
+
+To do so, put the following into your `~/.config/flake8` file:
+
+    [flake8]
+    max-line-length = 120
+
+

 History
 -------
 1.6: Deprecated configuring flake8 options through Vim settings.  Instead,
 History
 -------
 1.6: Deprecated configuring flake8 options through Vim settings.  Instead,

-advise users to use the flake8 config file.
+advise users to use the `~/.config/flake8` config file.
+
+    - Decprecated options:
+      - `g:flake8_builtins`
+      - `g:flake8_ignore`
+      - `g:flake8_max_line_length`
+      - `g:flake8_max_complexity`
+
+    - New options:
+      - `g:flake8_quickfix_height`

 
 1.5: Added markers and the option to don't show the quickfix window, also split
 functions into a autoload file. Added:
 
 1.5: Added markers and the option to don't show the quickfix window, also split
 functions into a autoload file. Added: