Skip to content

Commit af36c15

Browse files
committed
Working on docs.
1 parent a2d9a05 commit af36c15

File tree

1 file changed

+59
-9
lines changed

1 file changed

+59
-9
lines changed

doc/pymode.txt

Lines changed: 59 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -25,14 +25,10 @@ CONTENTS *pymode-contents*
2525
4. Rope support................................................|pymode-rope|
2626
4.1 Code completion..................................|pymode-completion|
2727
4.2 Find definition.................................|pymode-rope-findit|
28-
29-
2.Options.................................|PythonModeOptions|
30-
2.1.Customisation details.............|PythonModeOptionsDetails|
31-
3.Default Keys............................|PythonModeKeys|
32-
4.Commands................................|PythonModeCommands|
33-
5.FAQ.....................................|PythonModeFAQ|
34-
6.Credits.................................|PythonModeCredits|
35-
7.License.................................|PythonModeLicense|
28+
4.3 Refactoring................................|pymode-rope-refactoring|
29+
5.FAQ...........................................................|pymode-faq|
30+
6.Credits...................................................|pymode-credits|
31+
7.License...................................................|pymode-license|
3632

3733
==============================================================================
3834
1. Intro ~
@@ -314,6 +310,11 @@ Turn on the rope script *'g:pymode_rope'*
314310
>
315311
let g:pymode_rope = 1
316312
313+
Show documentation for object under cursor. *'g:pymode_rope_show_doc_bind'*
314+
Leave empty for disable key binding.
315+
>
316+
let g:pymode_rope_show_doc_bind = '<C-c>d'
317+
317318
------------------------------------------------------------------------------
318319
4.1 Completion ~
319320
*pymode-completion*
@@ -337,12 +338,27 @@ Keymap for autocomplete *'g:pymode_rope_completion_bind'*
337338
>
338339
let g:pymode_rope_completion_bind = '<C-Space>'
339340
341+
Extended autocompletion (rope could complete objects wich hasnt be imported)
342+
from project *'g:pymode_rope_autoimport'*
343+
>
344+
let g:pymode_rope_autoimport = 1
345+
346+
Load modules to autoimport by default *'g:pymode_rope_autoimport_modules'*
347+
>
348+
let g:pymode_rope_autoimport_modules = ['os', 'shutil', 'datetime'])
349+
350+
Offer to unresolved import object after completion.
351+
>
352+
let g:pymode_rope_autoimport_import_after_complete = 1
353+
354+
340355
------------------------------------------------------------------------------
341356
4.2 Find definition ~
342357
*pymode-rope-findit*
343358

344359
By default when you press *<C-C>g* on any object in your code you will be moved
345-
to definition. *'g:pymode_rope_goto_definition_bind'*
360+
to definition.
361+
Leave empty for disable key binding. *'g:pymode_rope_goto_definition_bind'*
346362
>
347363
let g:pymode_rope_goto_definition_bind = '<C-c>g'
348364
@@ -351,6 +367,40 @@ Values are (`e`, `new`, `vnew`)
351367
>
352368
let g:pymode_rope_goto_definition_cmd = 'new'
353369
370+
------------------------------------------------------------------------------
371+
4.3 Refactoring ~
372+
*pymode-rope-refactoring*
373+
374+
Rename method/function/class/variable in the project ~
375+
376+
Pymode can rename everything: classes, functions, modules, packages, methods,
377+
variables and keyword arguments.
378+
379+
Keymap for rename method/function/class/variables under cursor
380+
*'g:pymode_rope_rename_bind'*
381+
>
382+
let g:pymode_rope_rename_bind = '<C-c>rr'
383+
384+
Rename a current module/package ~
385+
386+
*:PymodeRopeRenameModule* -- Rename current module
387+
388+
Keymap for rename current module *'g:pymode_rope_rename_module_bind'*
389+
>
390+
let g:pymode_rope_rename_bind = '<C-c>rr'
391+
392+
Imports ~
393+
394+
Organize imports in current file (drop unused imports, sort imports)
395+
Keymap *'g:pymode_rope_organize_imports_bind'*
396+
>
397+
let g:pymode_rope_organize_imports_bind = '<C-c>ro'
398+
399+
Insert import for current word under cursor *'g:pymode_rope_autoimport_bind'*
400+
Should be enabled |'g:pymode_rope_autoimport'|
401+
>
402+
let g:pymode_rope_autoimport_bind = '<C-c>ra'
403+
354404
355405
356406

0 commit comments

Comments
 (0)