Merge pull request #72 from antoinemadec/no_blink

[etc/vim.git] / README.mdown

diff --git a/README.mdown b/README.mdown
index 5b83c992e68f2090f39c9f5163888f99f8060b0d..00d495151d7660cf02075967d5d18c110ffe7db0 100644 (file)
--- a/README.mdown
+++ b/README.mdown
@@ -5,17 +5,17 @@ a static syntax and style checker for Python source code.  It supersedes both
 [vim-pyflakes](https://github.com/nvie/vim-pyflakes) and
 [vim-pep8](https://github.com/nvie/vim-pep8).
 
 [vim-pyflakes](https://github.com/nvie/vim-pyflakes) and
 [vim-pep8](https://github.com/nvie/vim-pep8).
 

-[Flake8](http://pypi.python.org/pypi/flake8/) is a wrapper around PyFlakes 
-(static syntax checker), PEP8 (style checker) 
-and Ned's MacCabe script (complexity checker).
+[Flake8](https://pypi.python.org/pypi/flake8/) is a wrapper around PyFlakes
+(static syntax checker), PEP8 (style checker) and Ned's MacCabe script
+(complexity checker).

 
 
 Installation
 ------------
 Use [vim-pathogen](https://github.com/tpope/vim-pathogen) if you're not using
 
 
 Installation
 ------------
 Use [vim-pathogen](https://github.com/tpope/vim-pathogen) if you're not using

-it already.  Make sure you've installed the [flake8](http://pypi.python.org/pypi/flake8/) package.
-Then, simply put the contents of this repository in your
-`~/.vim/bundle` directory.
+it already.  Make sure you've installed the
+[flake8](https://pypi.python.org/pypi/flake8/) package.  Then, simply put the
+contents of this repository in your `~/.vim/bundle` directory.

 
 Usage
 -----
 
 Usage
 -----


@@ -39,21 +39,9 @@ the `<F7>` key if so.  For example, to remap it to `<F3>` instead, use:
 
     autocmd FileType python map <buffer> <F3> :call Flake8()<CR>
 
 
     autocmd FileType python map <buffer> <F3> :call Flake8()<CR>
 

-To add builtins, in your .vimrc:
+For flake8 configuration options please consult the following page:

 
 

-    let g:flake8_builtins="_,apply"
-
-To ignore errors, in your .vimrc:
-
-    let g:flake8_ignore="E501,W293"
-
-If you want to change the max line length for PEP8:
-
-    let g:flake8_max_line_length=99
-
-To set the maximum [McCabe complexity](https://en.wikipedia.org/wiki/Cyclomatic_complexity) before a warning is issued:
-
-    let g:flake8_max_complexity=10
+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`:
 


@@ -63,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


@@ -92,7 +84,7 @@ the empty string disables it. Ex.:
     flake8_complexity_marker=''  " disable McCabe complexity warnings
     flake8_naming_marker=''      " disable naming warnings
 
     flake8_complexity_marker=''  " disable McCabe complexity warnings
     flake8_naming_marker=''      " disable naming warnings
 

-To customize the colors used for markers, define the highligth groups, `Flake8_Error`,
+To customize the colors used for markers, define the highlight groups, `Flake8_Error`,

 `Flake8_Warning`, `Flake8_PyFlake`, `Flake8_Complexity`, `Flake8_Naming`:
 
     " to use colors defined in the colorscheme
 `Flake8_Warning`, `Flake8_PyFlake`, `Flake8_Complexity`, `Flake8_Naming`:
 
     " to use colors defined in the colorscheme


@@ -106,21 +98,46 @@ Tips
 ----
 A tip might be to run the Flake8 check every time you write a Python file, to
 enable this, add the following line to your `.vimrc` file (thanks
 ----
 A tip might be to run the Flake8 check every time you write a Python file, to
 enable this, add the following line to your `.vimrc` file (thanks

-[Godefroid](http://github.com/gotcha)!):
+[Godefroid](https://github.com/gotcha)!):

 
     autocmd BufWritePost *.py call Flake8()
 
 This plugin goes well together with the following plugin:
 
 
     autocmd BufWritePost *.py call Flake8()
 
 This plugin goes well together with the following plugin:
 

-- [PyUnit](http://github.com/nvie/vim-pyunit) (unit test helper under `<F8>`
+- [PyUnit](https://github.com/nvie/vim-pyunit) (unit test helper under `<F8>`

   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
 -------
 History
 -------

+1.6: Deprecated configuring flake8 options through Vim settings.  Instead,
+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:

 
     - Options:
       - `g:flake8_show_quickfix`
 
     - Options:
       - `g:flake8_show_quickfix`


@@ -158,3 +175,9 @@ a autoload file. Added:
 1.1: Added `g:flake8_ignore` option.
 
 1.0: Initial version.
 1.1: Added `g:flake8_ignore` option.
 
 1.0: Initial version.

+
+
+License
+-------
+
+Liberally licensed under BSD terms.