Skip to content

Commit 457e7a5

Browse files
klenklen
committed
Merge pull request #119 from bgrant/develop
Suggested edits for the help file.
2 parents 0473f6f + 9d51afc commit 457e7a5

File tree

1 file changed

+76
-64
lines changed

1 file changed

+76
-64
lines changed

‎doc/pymode.txt‎

Lines changed: 76 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,12 @@ CONTENTS *Python-mode-contents*
2525
1. Intro ~
2626
*PythonMode*
2727

28-
Python-mode is a vim plugin that allows you to use the pylint, rope, pydoc
29-
library in vim to provide features like python code looking for bugs,
30-
refactoring and some other useful things.
28+
Python-mode is a vim plugin that allows you to use the pylint, rope, and pydoc
29+
libraries in vim to provide features like python code bug checking,
30+
refactoring, and some other useful things.
3131

3232
This plugin allow you create python code in vim very easily. There is no need
33-
to install the pylint or rope library on your system.
33+
to install the pylint or rope libraries on your system.
3434

3535

3636
==============================================================================
@@ -41,7 +41,7 @@ to install the pylint or rope library on your system.
4141
Pylint options (ex. disable messages) may be defined in '$HOME/pylint.rc'
4242
See pylint documentation.
4343

44-
The script provides the following options that can customise the behaviour the
44+
This script provides the following options that can customise the behaviour of
4545
PythonMode. These options should be set in your vimrc.
4646

4747
|'pymode_paths'| Additional python paths for pymode
@@ -74,7 +74,7 @@ PythonMode. These options should be set in your vimrc.
7474

7575
|'pymode_lint_signs'| Place signs
7676

77-
|'pymode_lint_jump'| Auto jump on first error
77+
|'pymode_lint_jump'| Auto jump to first error
7878

7979
|'pymode_lint_hold'| Hold cursor in current window
8080

@@ -116,7 +116,7 @@ PythonMode. These options should be set in your vimrc.
116116
2.1. Customisation details ~
117117
*PythonModeOptionsDetails*
118118

119-
To enable any of the below options you should put the given line in your
119+
To enable any of the options below you should put the given line in your
120120
'$HOME/.vimrc'. See |vimrc-intro|.
121121

122122
------------------------------------------------------------------------------
@@ -157,7 +157,7 @@ This option set additional python import paths
157157
Values: 0 or 1.
158158
Default: 1.
159159

160-
If this option is set to 0 then docs script is disabled.
160+
If this option is set to 0 then the doc script is disabled.
161161

162162
------------------------------------------------------------------------------
163163
*'pymode_doc_key'*
@@ -183,7 +183,7 @@ Set key for run python code.
183183
Values: 0 or 1.
184184
Default: 1.
185185

186-
If this option is set to 0 then pylint script is disabled.
186+
If this option is set to 0 then the pylint script is disabled.
187187

188188
------------------------------------------------------------------------------
189189
*'pymode_lint_checker'*
@@ -192,11 +192,11 @@ Values: "pylint", "pyflakes", "pep8", "mccabe"
192192

193193
Default: "pyflakes,pep8,mccabe".
194194

195-
This option set code checkers.
195+
This option sets code checkers.
196196

197197
------------------------------------------------------------------------------
198198
*'pymode_lint_ignore'*
199-
Values: IDs of errors, separated by commas or empty string
199+
Values: IDs of errors, separated by commas or empty strings
200200
E.g. "E501,W002", "E2,W" (Skip all Warnings and Errors startswith E2) and etc ~
201201

202202
Default: "E501".
@@ -206,7 +206,7 @@ See also: |'pymode_lint_select'|, |'pymode_lint_config'|
206206

207207
------------------------------------------------------------------------------
208208
*'pymode_lint_select'*
209-
Values: IDs of errors, separated by commas or empty string
209+
Values: IDs of errors, separated by commas or empty strings
210210
E.g. "W002,C" Force W002 and all C-ids ~
211211

212212
Default: "".
@@ -219,15 +219,15 @@ See also: |'pymode_lint_ignore'|, |'pymode_lint_config'|
219219
Values: 0 or 1
220220
Default: 0
221221

222-
This option enabled "on the fly" code checking
222+
This option enables "on the fly" code checking
223223

224224
------------------------------------------------------------------------------
225225
*'pymode_lint_config'*
226226
Values: 'Path to pylint configuration file'
227227
Default: "$HOME/.pylintrc"
228228

229-
If this option is set path to pylint configuration. If configuration not found
230-
uses file 'pylintrc' from python-mode sources.
229+
This option sets the path to the pylint configuration file. If the
230+
file is not found, use the 'pylintrc' file from python-mode sources.
231231

232232
See also: |'pymode_lint_ignore'|, |'pymode_lint_select'|
233233

@@ -236,91 +236,92 @@ See also: |'pymode_lint_ignore'|, |'pymode_lint_select'|
236236
Values: 0 or 1.
237237
Default: 1.
238238

239-
If this option is set to 0 then pylint auto check every save is disabled.
239+
If this option is set to 0, then pylint auto-checking on every save is
240+
disabled.
240241

241242
------------------------------------------------------------------------------
242243
*'pymode_lint_cwindow'*
243244
Values: 0 or 1.
244245
Default: 1.
245246

246-
If this option is set to 0 then pylint not show cwindow.
247+
If this option is set to 0 then pylint will not show cwindow.
247248

248249
------------------------------------------------------------------------------
249250
*'pymode_lint_message'*
250251
Values: 0 or 1.
251252
Default: 1.
252253

253-
If this option is set to 0 then pylint not show errors in bottom
254+
If this option is set to 0 then pylint will not show errors at bottom.
254255

255256
------------------------------------------------------------------------------
256257
*'pymode_lint_signs'*
257258
Values: 0 or 1.
258259
Default: 1.
259260

260-
If this option is set to 0 then pylint not place error signs.
261+
If this option is set to 0 then pylint will not place error signs.
261262

262263
------------------------------------------------------------------------------
263264
*'pymode_lint_jump'*
264265
Values: 0 or 1.
265266
Default: 0.
266267

267-
If this option is set to 0 then pylint not jump on first error.
268+
If this option is set to 0 then pylint will not jump to the first error.
268269

269270
------------------------------------------------------------------------------
270271
*'pymode_lint_hold'*
271272
Values: 0 or 1.
272273
Default: 0.
273274

274-
If this option is set to 0 then pylint switch on quickfix window when it open
275-
Not working when |'pymode_lint_jump'| enabled.
275+
If this option is set to 0 then pylint will switch on the quickfix window when
276+
it opens. Doesn't work when |'pymode_lint_jump'| enabled.
276277

277278
------------------------------------------------------------------------------
278279
*'pymode_lint_minheight'*
279280
Values: int
280281
Default: 3.
281282

282-
Set minimal height for pylint cwindow
283+
Set minimal height for the pylint cwindow.
283284

284285
------------------------------------------------------------------------------
285286
*'pymode_lint_mccabe_complexity'*
286287
Values: int
287288
Default: 8.
288289

289-
Set minimal complexity for mccabe linter.
290+
Set minimal complexity for the mccabe linter.
290291

291292
------------------------------------------------------------------------------
292293
*'pymode_lint_maxheight'*
293294
Values: int
294295
Default: 6.
295296

296-
Set maximal height for pylint cwindow
297+
Set maximal height for the pylint cwindow.
297298

298299
------------------------------------------------------------------------------
299300
*'pymode_rope'*
300301
Values: 0 or 1.
301302
Default: 1.
302303

303-
If this option is set to 0 then rope script is disabled.
304+
If this option is set to 0 then the rope script is disabled.
304305

305306
------------------------------------------------------------------------------
306307
*'pymode_breakpoint'*
307308
Values: 0 or 1.
308309
Default: 1.
309310

310-
If this option is set to 0 then breakpoint script is disabled.
311+
If this option is set to 0 then the breakpoint script is disabled.
311312

312313
------------------------------------------------------------------------------
313314
*'pymode_breakpoint_key'*
314315
Default: '<leader>b'.
315316

316-
Key for set/unset breakpoint
317+
Key for setting/unsetting breakpoints.
317318

318319
------------------------------------------------------------------------------
319320
*'pymode_utils'*
320321
Values: 0 or 1.
321322
Default: 1.
322323

323-
If this option is set to 0 then utils script is disabled.
324+
If this option is set to 0 the then utils script is disabled.
324325

325326
------------------------------------------------------------------------------
326327
*'pymode_virtualenv'*
@@ -334,7 +335,7 @@ If this option is set to 0 then virtualenv support is disabled.
334335
Values: 0 or 1.
335336
Default: 1.
336337

337-
Autoremove unused whitespaces
338+
Auto-remove unused whitespaces.
338339

339340
------------------------------------------------------------------------------
340341
*'pymode_syntax'*
@@ -349,7 +350,8 @@ not be used.
349350
Values: 0 or 1.
350351
Default: 1.
351352

352-
If this option is set to 1, pymode enable next options for python buffers: >
353+
If this option is set to 1, pymode will enable the following options for python
354+
buffers: >
353355
354356
setlocal cinwords=if,elif,else,for,while,try,except,finally,def,class
355357
setlocal cindent
@@ -367,14 +369,15 @@ If this option is set to 1, pymode enable next options for python buffers: >
367369
Values: 0 or 1.
368370
Default: 1.
369371

370-
If this option is set to 1, pymode enable python-folding.
372+
If this option is set to 1, pymode will enable python-folding.
371373

372374
------------------------------------------------------------------------------
373375
*'pymode_options_other'*
374376
Values: 0 or 1.
375377
Default: 1.
376378

377-
If this option is set to 1, pymode enable next options for python buffers: >
379+
If this option is set to 1, pymode will enable the following options for python
380+
buffers: >
378381
379382
setlocal complete+=t
380383
setlocal formatoptions-=t
@@ -387,16 +390,16 @@ If this option is set to 1, pymode enable next options for python buffers: >
387390
Values: 0 or 1.
388391
Default: 1.
389392

390-
If this option is set to 1, pymode enable some python motions. Pymode-motion
391-
is beta.
393+
If this option is set to 1, pymode will enable some python motions.
394+
Pymode-motion is beta.
392395

393396
================ ============================
394397
Key Command
395398
================ ============================
396-
[[ Jump on previous class or function (normal, visual, operator modes)
397-
]] Jump on next class or function (normal, visual, operator modes)
398-
[M Jump on previous class or method (normal, visual, operator modes)
399-
]M Jump on next class or method (normal, visual, operator modes)
399+
[[ Jump to previous class or function (normal, visual, operator modes)
400+
]] Jump to next class or function (normal, visual, operator modes)
401+
[M Jump to previous class or method (normal, visual, operator modes)
402+
]M Jump to next class or method (normal, visual, operator modes)
400403
aC Select a class. Ex: vaC, daC, yaC, caC (normal, operator modes)
401404
iC Select inner class. Ex: viC, diC, yiC, ciC (normal, operator modes)
402405
aM Select a function or method. Ex: vaM, daM, yaM, caM (normal, operator modes)
@@ -408,7 +411,7 @@ iM Select inner function or method. Ex: viM, diM, yiM, ciM (norma
408411
3. Default Keys ~
409412
*PythonModeKeys*
410413

411-
For redefine keys see: |PythonModeOptions|
414+
To redefine keys, see: |PythonModeOptions|
412415

413416
================ ============================
414417
Key Command
@@ -417,10 +420,10 @@ K Show python docs for current word under cursor
417420
C-Space Rope code assist
418421
<leader>r Run current buffer
419422
<leader>b Set breakpoints
420-
[[ Jump on previous class or function (normal, visual, operator modes)
421-
]] Jump on next class or function (normal, visual, operator modes)
422-
[M Jump on previous class or method (normal, visual, operator modes)
423-
]M Jump on next class or method (normal, visual, operator modes)
423+
[[ Jump to previous class or function (normal, visual, operator modes)
424+
]] Jump to next class or function (normal, visual, operator modes)
425+
[M Jump to previous class or method (normal, visual, operator modes)
426+
]M Jump to next class or method (normal, visual, operator modes)
424427
aC C Operation with a class.
425428
Ex: vaC, daC, dC, yaC, yC, caC, cC (normal, operator modes)
426429
iC Operation with inner class.
@@ -449,7 +452,7 @@ iM Operation with inner function or method.
449452
Check current buffer
450453

451454
*:PyLintAuto* *PyLintAuto*
452-
Automatic fix PEP8 errors in current buffer
455+
Automatically fix PEP8 errors in the current buffer
453456

454457
*:Pyrun* *Pyrun*
455458
Run current buffer
@@ -459,36 +462,45 @@ iM Operation with inner function or method.
459462
5. FAQ ~
460463
*PythonModeFAQ*
461464

462-
Python-mode dont work
463-
---------------------
465+
Python-mode doesn't work
466+
------------------------
464467

465-
Run ":call pymode#troubleshooting#Test()", fix warning or send me output.
468+
Run ":call pymode#troubleshooting#Test()" and fix the warning or send me the
469+
output.
466470

467471

468472
Rope completion is very slow
469473
----------------------------
470474

471-
To work rope_ creates a service directory: `.ropeproject`.
472-
If |'pymode_rope_guess_project'| set on (by default) and `.ropeproject` in current dir not found, rope scan `.ropeproject` on every dir in parent path.
473-
If rope finded `.ropeproject` in parent dirs, rope set project for all child dir and scan may be slow for many dirs and files.
475+
To work, rope_ creates a service directory: `.ropeproject`. If
476+
|'pymode_rope_guess_project'| is set on (as it is by default) and
477+
`.ropeproject` is not found in the current dir, rope will scan for
478+
`.ropeproject` in every dir in the parent path. If rope finds `.ropeproject`
479+
in parent dirs, rope sets project for all child dir and the scan may be slow
480+
for many dirs and files.
474481

475482
Solutions:
476483

477-
- Disable |'pymode_rope_guess_project'| to make rope always create `.ropeproject` in current dir.
478-
- Delete `.ropeproject` from dip parent dir to make rope create `.ropeproject` in current dir.
479-
- Press `<C-x>po` or `:RopeOpenProject` to make force rope create `.ropeproject` in current dir.
480-
484+
- Disable |'pymode_rope_guess_project'| to make rope always create
485+
`.ropeproject` in the current dir.
486+
- Delete `.ropeproject` from the parent dir to make rope create `.ropeproject`
487+
in the current dir.
488+
- Press `<C-x>po` or `:RopeOpenProject` to force rope to create `.ropeproject`
489+
in the current dir.
481490

482491

483492
Pylint check is very slow
484493
-------------------------
485494

486-
In some projects pylint_ may check slowly, because it also scan imported modules if possible.
487-
Try use pyflakes, see |'pymode_lint_checker'|.
495+
In some projects pylint_ may check slowly, because it also scan imported
496+
modules if possible. Try using pyflakes: see |'pymode_lint_checker'|.
488497

489-
You may set |exrc| and |secure| in your |vimrc| for auto set custom settings from `.vimrc` from your projects directories.
498+
You may set |exrc| and |secure| in your |vimrc| to auto-set custom settings
499+
from `.vimrc` from your projects directories.
490500
>
491-
Example: On Flask projects I automatically set 'g:pymode_lint_checker = "pyflakes"', on Django 'g:pymode_lint_checker = "pylint"'
501+
Example: On Flask projects I automatically set
502+
'g:pymode_lint_checker = "pyflakes"'.
503+
On Django 'g:pymode_lint_checker = "pylint"'
492504
<
493505

494506

@@ -528,14 +540,14 @@ You may set |exrc| and |secure| in your |vimrc| for auto set custom settings fro
528540
7. License ~
529541
*PythonModeLicense*
530542

531-
The Python-mode is released under the GNU lesser general public license.
543+
Python-mode is released under the GNU lesser general public license.
532544
See: http://www.gnu.org/copyleft/lesser.html
533545

534-
If you like this plugin, you can send me postcard :)
535-
My address is here: "Russia, 143401, Krasnogorsk, Shkolnaya 1-19" to "Kirill Klenov".
536-
Thanks for support!
546+
If you like this plugin, you can send me a postcard :)
547+
My address is: "Russia, 143401, Krasnogorsk, Shkolnaya 1-19" to "Kirill Klenov".
548+
Thanks for your support!
537549

538-
Version 0.6.5: I still haven't received any postcard, guys :(
550+
Version 0.6.5: I still haven't received any postcards, guys :(
539551

540552

541553
------------------------------------------------------------------------------

0 commit comments

Comments
 (0)