Skip to content

Commit 6d23111

Browse files
committed
Minor documentation update
1 parent 621b04a commit 6d23111

File tree

2 files changed

+19
-17
lines changed

2 files changed

+19
-17
lines changed

README.rst

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -44,38 +44,40 @@ Or you can just manually place `syntax/python.vim
4444
<https://github.com/vim-python/python-syntax/blob/master/syntax/python.vim>`_
4545
into ``~/.config/nvim/syntax/`` or ``~/.vim/syntax/``.
4646

47-
Script options
47+
Configuration
4848
--------------
4949

5050
Enable option with::
5151

52-
let OPTION_NAME = 1
52+
let VARIABLE = 1
5353

5454
Disable option with::
5555

56-
let OPTION_NAME = 0
56+
let VARIABLE = 0
5757

58-
For example to enable all syntax highlighting features you can place the
59-
following command in your ``~/.config/nvim/init.vim`` or ``~/.vimrc`` script::
58+
For example to enable all syntax highlighting features you can add the
59+
following command to your ``~/.config/nvim/init.vim`` or ``~/.vimrc``::
6060

6161
let g:python_highlight_all = 1
6262

63-
Options and commands to select Python version
64-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
63+
Select Python version
64+
~~~~~~~~~~~~~~~~~~~~~
65+
66+
Variables:
6567

6668
``g:python_version_2`` or ``b:python_version_2``
6769
Enable highlighting for Python 2 (Python 3 highlighting is enabled by
6870
default).
6971

70-
The following commands can be used to switch between modes:
72+
Commands to easily switch between modes:
7173

7274
``Python2Syntax``
7375
Switch to Python 2
7476
``Python3Syntax``
7577
Switch to Python 3
7678

77-
Other options
78-
~~~~~~~~~~~~~
79+
Option variables
80+
~~~~~~~~~~~~~~~~
7981

8082
``g:python_highlight_builtins``
8183
Highlight builtin functions and objects

doc/python-syntax.txt

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -35,33 +35,33 @@ Configuration *python-syntax-configuration
3535

3636
Enable option with: >
3737

38-
let OPTION_NAME = 1
38+
let VARIABLE = 1
3939
<
4040
Disable option with: >
4141

42-
let OPTION_NAME = 0
42+
let VARIABLE = 0
4343
<
44-
For example to enable all syntax highlighting features you can place the
45-
following command in your `~/.config/nvim/init.vim` or `~/.vimrc` script: >
44+
For example to enable all syntax highlighting features you can add the
45+
following command to your `~/.config/nvim/init.vim` or `~/.vimrc`: >
4646

4747
let g:python_highlight_all = 1
4848
<
4949
-------------------------------------------------------------------------------
50-
Options and commands to select Python version *python-syntax-version*
50+
Select Python version *python-syntax-version*
5151

5252
`g:python_version_2` or `b:python_version_2`
5353
Enable highlighting for Python 2 (Python 3 highlighting is enabled by
5454
default).
5555

56-
The following commands can be used to switch between modes:
56+
Commands to easily switch between modes:
5757

5858
`Python2Syntax`
5959
Switch to Python 2
6060
`Python3Syntax`
6161
Switch to Python 3
6262

6363
-------------------------------------------------------------------------------
64-
Options *python-syntax-options*
64+
Option variables *python-syntax-options* *python-syntax-variables*
6565

6666
`g:python_highlight_builtins`
6767
Highlight builtin functions and objects

0 commit comments

Comments
 (0)