From 6d231116fa901bdf7ea09d3c6ba366e48dc56453 Mon Sep 17 00:00:00 2001 From: nfnty Date: Thu, 16 Feb 2017 22:06:25 +0100 Subject: [PATCH] Minor documentation update --- README.rst | 22 ++++++++++++---------- doc/python-syntax.txt | 14 +++++++------- 2 files changed, 19 insertions(+), 17 deletions(-) diff --git a/README.rst b/README.rst index 25c6ae6..a9335be 100644 --- a/README.rst +++ b/README.rst @@ -44,38 +44,40 @@ Or you can just manually place `syntax/python.vim `_ into ``~/.config/nvim/syntax/`` or ``~/.vim/syntax/``. -Script options +Configuration -------------- Enable option with:: - let OPTION_NAME = 1 + let VARIABLE = 1 Disable option with:: - let OPTION_NAME = 0 + let VARIABLE = 0 -For example to enable all syntax highlighting features you can place the -following command in your ``~/.config/nvim/init.vim`` or ``~/.vimrc`` script:: +For example to enable all syntax highlighting features you can add the +following command to your ``~/.config/nvim/init.vim`` or ``~/.vimrc``:: let g:python_highlight_all = 1 -Options and commands to select Python version -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Select Python version +~~~~~~~~~~~~~~~~~~~~~ + +Variables: ``g:python_version_2`` or ``b:python_version_2`` Enable highlighting for Python 2 (Python 3 highlighting is enabled by default). -The following commands can be used to switch between modes: +Commands to easily switch between modes: ``Python2Syntax`` Switch to Python 2 ``Python3Syntax`` Switch to Python 3 -Other options -~~~~~~~~~~~~~ +Option variables +~~~~~~~~~~~~~~~~ ``g:python_highlight_builtins`` Highlight builtin functions and objects diff --git a/doc/python-syntax.txt b/doc/python-syntax.txt index 4980d3a..7fbb4f7 100644 --- a/doc/python-syntax.txt +++ b/doc/python-syntax.txt @@ -35,25 +35,25 @@ Configuration *python-syntax-configuration Enable option with: > - let OPTION_NAME = 1 + let VARIABLE = 1 < Disable option with: > - let OPTION_NAME = 0 + let VARIABLE = 0 < -For example to enable all syntax highlighting features you can place the -following command in your `~/.config/nvim/init.vim` or `~/.vimrc` script: > +For example to enable all syntax highlighting features you can add the +following command to your `~/.config/nvim/init.vim` or `~/.vimrc`: > let g:python_highlight_all = 1 < ------------------------------------------------------------------------------- -Options and commands to select Python version *python-syntax-version* +Select Python version *python-syntax-version* `g:python_version_2` or `b:python_version_2` Enable highlighting for Python 2 (Python 3 highlighting is enabled by default). -The following commands can be used to switch between modes: +Commands to easily switch between modes: `Python2Syntax` Switch to Python 2 @@ -61,7 +61,7 @@ The following commands can be used to switch between modes: Switch to Python 3 ------------------------------------------------------------------------------- -Options *python-syntax-options* +Option variables *python-syntax-options* *python-syntax-variables* `g:python_highlight_builtins` Highlight builtin functions and objects