vim/YouCompleteMe
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

More doc updates for Completer API

Browse Source
This commit is contained in:
Strahinja Val Markovic 2013-02-16 13:30:18 -08:00
parent 1cd6f4d05e
commit 7833cc1cf1
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
python/completers/completer.py
View File

@ -28,8 +28,8 @@ class Completer( object ):
"""A base class for all Completers in YCM. """A base class for all Completers in YCM.
Here's several important things you need to know if you're writing a custom Here's several important things you need to know if you're writing a custom
Completer. First, there are several very important functions that the Vim part Completer. The following are functions that the Vim part of YCM will be
of YCM will be calling on your Completer. calling on your Completer:
ShouldUseNow() is called with the start column of where a potential completion ShouldUseNow() is called with the start column of where a potential completion
string should start. For instance, if the user's input is 'foo.bar' and the string should start. For instance, if the user's input is 'foo.bar' and the
@ -60,7 +60,7 @@ class Completer( object ):
CandidatesForQueryAsync() is the main entry point when the user types. For CandidatesForQueryAsync() is the main entry point when the user types. For
"foo.bar", the user query is "bar" and completions matching this string should "foo.bar", the user query is "bar" and completions matching this string should
be shown. The job of CandidatesForQueryAsync() is to merely initiate this be shown. The job of CandidatesForQueryAsync() is to merely initiate this
request, hopefully in the background with a thread. request, which will hopefully be processed in a background thread.
AsyncCandidateRequestReady() is the function that is repeatedly polled until AsyncCandidateRequestReady() is the function that is repeatedly polled until
it returns True. If CandidatesForQueryAsync() started a background task of it returns True. If CandidatesForQueryAsync() started a background task of