Some extra docs for the Completer API

This commit is contained in:
Strahinja Val Markovic 2013-02-16 13:26:56 -08:00
parent 3f1b5c9283
commit 1cd6f4d05e

View File

@ -42,11 +42,12 @@ class Completer( object ):
better than nothing. better than nothing.
Note that it's HIGHLY likely that you want to override the ShouldUseNowInner() Note that it's HIGHLY likely that you want to override the ShouldUseNowInner()
function instead of ShouldUseNow() directly. ShouldUseNow() will call your function instead of ShouldUseNow() directly (although chances are that you
*Inner version of the function and will also make sure that the completion probably won't have any need to override either). ShouldUseNow() will call
cache is taken into account. You'll see this pattern repeated throughout the your *Inner version of the function and will also make sure that the
Completer API; YCM calls the "main" version of the function and that function completion cache is taken into account. You'll see this pattern repeated
calls the *Inner version while taking into account the cache. throughout the Completer API; YCM calls the "main" version of the function and
that function calls the *Inner version while taking into account the cache.
The cache is important and is a nice performance boost. When the user types in The cache is important and is a nice performance boost. When the user types in
"foo.", your completer will return a list of all member functions and "foo.", your completer will return a list of all member functions and