Skip to content

Commit 02dfc8c

Browse files
committed
Add new file doc/python-indent.txt
1 parent 30014e2 commit 02dfc8c

1 file changed

Lines changed: 86 additions & 0 deletions

File tree

doc/python-indent.txt

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
*python-indent.txt* Indent in compilance with PEP 8
2+
3+
Author: Akinori Hattori <hattya@gmail.com>
4+
Repository: https://github.com/hattya/python-indent.vim
5+
Last Change: 2022-10-09
6+
License: MIT License
7+
8+
CONTENTS *python-indent-contents*
9+
10+
Introduction |python-indent-introduction|
11+
Interface |python-indent-interface|
12+
Variables |python-indent-variables|
13+
14+
==============================================================================
15+
INTRODUCTION *python-indent-introduction*
16+
17+
*python-indent.vim* is a Vim indent plugin for Python which compiles with PEP 8.
18+
19+
NOTE: |python-indent.vim| does not take comments into account when calculating
20+
indent width.
21+
22+
==============================================================================
23+
INTERFACE *python-indent-interface*
24+
25+
------------------------------------------------------------------------------
26+
VARIABLES *python-indent-variables*
27+
28+
g:python_indent_continue *g:python_indent_continue*
29+
b:python_indent_continue *b:python_indent_continue*
30+
The indent width for a continuation line.
31+
The default value is 'shiftwidth'.
32+
>
33+
value = 1 + \
34+
2 + \
35+
3
36+
value = func(
37+
1,
38+
2,
39+
3)
40+
41+
g:python_indent_right_bracket *g:python_indent_right_bracket*
42+
b:python_indent_right_bracket *b:python_indent_right_bracket*
43+
If set to 1, a right bracket will be lined up under the first
44+
non-whitespace character of the last line.
45+
46+
Default: >
47+
value = [
48+
1,
49+
2,
50+
3,
51+
]
52+
value = func(
53+
1,
54+
2,
55+
3,
56+
)
57+
<
58+
If set to 1: >
59+
value = [
60+
1,
61+
2,
62+
3,
63+
]
64+
value = func(
65+
1,
66+
2,
67+
3,
68+
)
69+
70+
g:python_indent_multiline_statement *g:python_indent_multiline_statement*
71+
b:python_indent_multiline_statement *b:python_indent_multiline_statement*
72+
If set to 1, add some extra indentation on the conditional
73+
continuation line.
74+
75+
Default: >
76+
if (isinstance(path, str) and
77+
os.path.isfile(path)):
78+
pass
79+
<
80+
If set to 1: >
81+
if (isinstance(path, str) and
82+
os.path.isfile(path)):
83+
pass
84+
85+
==============================================================================
86+
vim:tw=78:ts=8:ft=help:norl:noet

0 commit comments

Comments
 (0)