From 1cd6f4d05efa969964f503e314a1bc259e22ea9b Mon Sep 17 00:00:00 2001 From: Strahinja Val Markovic Date: Sat, 16 Feb 2013 13:26:56 -0800 Subject: [PATCH] Some extra docs for the Completer API --- python/completers/completer.py | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/python/completers/completer.py b/python/completers/completer.py index 90d7dfed..cba18dfc 100644 --- a/python/completers/completer.py +++ b/python/completers/completer.py @@ -42,11 +42,12 @@ class Completer( object ): better than nothing. Note that it's HIGHLY likely that you want to override the ShouldUseNowInner() - function instead of ShouldUseNow() directly. ShouldUseNow() will call your - *Inner version of the function and will also make sure that the completion - cache is taken into account. You'll see this pattern repeated 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. + function instead of ShouldUseNow() directly (although chances are that you + probably won't have any need to override either). ShouldUseNow() will call + your *Inner version of the function and will also make sure that the + completion cache is taken into account. You'll see this pattern repeated + 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 "foo.", your completer will return a list of all member functions and