Skip to content

Commit

Permalink
- documentation updates
Browse files Browse the repository at this point in the history
  • Loading branch information
Julian Eberius committed Oct 27, 2012
1 parent 104f08b commit bfd2578
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 4 deletions.
11 changes: 9 additions & 2 deletions docs/source/auto_completion.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,17 +12,24 @@ ST2 offers three types of completions itself:

.. note::

Some people prefer to disable the default word and/or explicit completions that ST2 offers while using SublimeRope. This can be archieved by setting either of the following settings to ``true`` in the User Settings for SublimeRope settings in your ST2 Preferences Menú.
Some people prefer to disable the default word and/or explicit completions that ST2 offers while using SublimeRope. This can be achieved by setting either of the following settings to ``true`` in the User Settings for SublimeRope settings in your ST2 Preferences Menú.

* ``suppress_word_completions``
* ``suppress_explicit_completions``

Manual Completions
==================

On larger projects, generating the completion proposals can take a noticeable amount of time. Waiting half a second is no problem usually, but with ST2 automatic as-you-type completions it can slow down your typing.
Just set the "complete_as_you_type" option in your SublimeRope.sublime_settings or in your project settings as "rope_complete_as_you_type" to false, and you will only get the lightning fast buffer-based completions from ST2. Then you can manually trigger the more intelligent Rope-based completions using the "PythonManualCompletionRequestCommand".
Bind it to some nice key, e.g. ctrl+alt+space, and you can get them easily when you need them.

Simple Completion
=================

SublimeRope provides completion suggestions based on the rope library, but also offers a fall-back method if rope suggest nothing. Albeit it is sometimes useful, it is disabled by default because some users feels that it slows down the plugin too much.

You can enbale it setting ``use_simple_completion`` to true in SublimeRope settings file.
You can enable it setting ``use_simple_completion`` to true in SublimeRope settings file.

Howto get autocompletion on dot typing?
===========================================
Expand Down
2 changes: 1 addition & 1 deletion docs/source/cache_mechanisms.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ This action can be archieved using the ST2 Command Palette.
The old way: editing Rope python path
=====================================
.. warning::
This is *NOT* the recommended way of settings cache for get all auto completions working.
This is *NOT* the recommended way of settings cache to get all auto completions working anymore.

Basically, anything you want completions for (or auto import, jump to globals, documentation) has to be in the Rope's python path. You can extend the Rope's python path editing the ``.ropeproject/config.py`` (If you don't know what ``.ropeproject`` directory is you should look at :ref:`create_project`)

Expand Down
7 changes: 6 additions & 1 deletion docs/source/key_bindings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,4 +60,9 @@ SublimeRope provides no default keybindings at the moment, so you need to set th
[
{ "key": "selector", "operator": "equal", "operand": "source.python"}
]
}
},
{ "keys": ["ctrl+alt+space"], "command": "python_manual_completion_request", "context":
[
{ "key": "selector", "operator": "equal", "operand": "source.python" }
]
},

0 comments on commit bfd2578

Please sign in to comment.