Skip to content

Commit 621b04a

Browse files
committed
doc: Add introduction
1 parent 624b675 commit 621b04a

File tree

1 file changed

+31
-1
lines changed

1 file changed

+31
-1
lines changed

doc/python-syntax.txt

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,34 @@
1-
*python-syntax* *ft-python-syntax* *python.vim*
1+
*python-syntax.txt* Python syntax highlighting
2+
3+
===============================================================================
4+
Introduction *python-syntax* *ft-python-syntax* *python.vim*
5+
6+
This is an enhanced version of the original Python syntax highlighting script. Based on
7+
`python.vim` from Vim 6.1 distribution by Neil Schemenauer.
8+
9+
Features
10+
--------
11+
12+
- Added support for Python 3 syntax highlighting
13+
- Added commands `Python2Syntax` and `Python3Syntax` commands which allow to switch
14+
between Python 2 and Python 3 syntaxes respectively without reloads/restarts
15+
- Updated string highlighting
16+
- Enhanced special symbols highlighting inside strings
17+
- Enhanced highlighting of numeric constants
18+
- Added optional highlighting for %-formatting inside strings
19+
- Added highlighting for magic comments: source code encoding and #! (executable) strings
20+
- Added highlighting for new exceptions and builtins
21+
- Added highlighting for doctests
22+
- Added highlighting for new `@decorator` syntax introduced in Python 2.4a2
23+
- Added highlighting for the following errors:
24+
- Invalid symbols in source file
25+
- Mixing spaces and tabs
26+
- Invalid numeric constants
27+
- Invalid %-formatting inside strings
28+
- Invalid variable names
29+
- Trailing spaces (triggered by the `python_highlight_space_errors` option)
30+
31+
Folding is done by the plugin `SimpylFold` (`https://github.com/tmhedberg/SimpylFold`)
232

333
===============================================================================
434
Configuration *python-syntax-configuration*

0 commit comments

Comments
 (0)