Update documentation

This commit is contained in:
nfnty
2017-02-16 20:37:38 +01:00
parent 80da95bd41
commit 624b675621
2 changed files with 122 additions and 161 deletions

View File

@@ -1,65 +1,63 @@
PYTHON *python.vim* *ft-python-syntax*
*python-syntax* *ft-python-syntax* *python.vim*
There are two commands to enable or disable an option for python.vim
===============================================================================
Configuration *python-syntax-configuration*
Enable option: >
:let option_name = 1
Enable option with: >
let OPTION_NAME = 1
<
Disable option: >
:let option_name = 0
Disable option with: >
let OPTION_NAME = 0
<
For example to enable all syntax highlighting features you can place the
following command in your `~/.vimrc` script: >
following command in your `~/.config/nvim/init.vim` or `~/.vimrc` script: >
let python_highlight_all = 1
let g:python_highlight_all = 1
<
Option and commands to select Python version: >
-------------------------------------------------------------------------------
Options and commands to select Python version *python-syntax-version*
:let python_version_2 = 1
<
Enable highlighting for Python 2 (Python 3 highlighting is enabled by
default). Also can be set as a local to buffer `b:python_version_2`
variable.
`g:python_version_2` or `b:python_version_2`
Enable highlighting for Python 2 (Python 3 highlighting is enabled by
default).
The following local to buffer commands can be used to switch between two
highlighting modes:
The following commands can be used to switch between modes:
Switch to Python 2 highlighting mode >
:Python2Syntax
<
Switch to Python 3 highlighting mode >
:Python3Syntax
<
Options used by the script
`Python2Syntax`
Switch to Python 2
`Python3Syntax`
Switch to Python 3
Highlight builtin functions and objects >
:let python_highlight_builtins = 1
< Highlight builtin objects only >
:let python_highlight_builtin_objs = 1
< Highlight builtin functions only >
:let python_highlight_builtin_funcs = 1
< Highlight standard exceptions >
:let python_highlight_exceptions = 1
< Highlight `%` string formatting >
:let python_highlight_string_formatting = 1
< Highlight syntax of `str.format` syntax >
:let python_highlight_string_format = 1
< Highlight syntax of `string.Template` >
:let python_highlight_string_templates = 1
< Highlight indentation errors >
:let python_highlight_indent_errors = 1
< Highlight trailing spaces >
:let python_highlight_space_errors = 1
< Highlight doc-tests >
:let python_highlight_doctests = 1
< Highlight `print` statement as function for Python 2 >
:let python_print_as_function = 1
< Highlight shebang and coding headers as comments >
:let python_highlight_file_headers_as_comments = 1
< Enable all the options above. NOTE: This option don't override any
previously set options >
:let python_highlight_all = 1
< Can be set to 0 for slow machines >
:let python_slow_sync = 1
<
vim:tw=78:sw=4:ts=8:ft=help:norl:
-------------------------------------------------------------------------------
Options *python-syntax-options*
`g:python_highlight_builtins`
Highlight builtin functions and objects
`g:python_highlight_builtin_objs`
Highlight builtin objects only
`g:python_highlight_builtin_funcs`
Highlight builtin functions only
`g:python_highlight_exceptions`
Highlight standard exceptions
`g:python_highlight_string_formatting`
Highlight `%` string formatting
`g:python_highlight_string_format`
Highlight syntax of `str.format` syntax
`g:python_highlight_string_templates`
Highlight syntax of `string.Template`
`g:python_highlight_indent_errors`
Highlight indentation errors
`g:python_highlight_space_errors`
Highlight trailing spaces
`g:python_highlight_doctests`
Highlight doc-tests
`g:python_print_as_function`
Highlight `print` statement as function for Python 2
`g:python_highlight_file_headers_as_comments`
Highlight shebang and coding headers as comments
`g:python_highlight_all`
Enable all the options above - NOTE: Doesn't override any previously set options
`g:python_slow_sync`
Disable for slow machines