From: Noam Postavsky <npostavs@gmail.com>
Date: Sat, 25 Jun 2016 20:23:04 +0000 (-0400)
Subject: Add to elisp-completion-at-point's docstring
X-Git-Tag: emacs-25.1-rc1~60
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=ebf047254b374eedc6fa24625d30213aa095cab9;p=emacs.git

Add to elisp-completion-at-point's docstring

* lisp/progmodes/elisp-mode.el (elisp-completion-at-point): Document
position dependent behavior (Bug #19854).
---

diff --git a/lisp/progmodes/elisp-mode.el b/lisp/progmodes/elisp-mode.el
index 7ad88712a4d..5111f887091 100644
--- a/lisp/progmodes/elisp-mode.el
+++ b/lisp/progmodes/elisp-mode.el
@@ -455,7 +455,13 @@ It can be quoted, or be inside a quoted form."
      ((facep sym) (find-definition-noselect sym 'defface)))))
 
 (defun elisp-completion-at-point ()
-  "Function used for `completion-at-point-functions' in `emacs-lisp-mode'."
+  "Function used for `completion-at-point-functions' in `emacs-lisp-mode'.
+If the context at point allows only a certain category of
+symbols (e.g. functions, or variables) then the returned
+completions are restricted to that category.  In contexts where
+any symbol is possible (following a quote, for example),
+functions are annotated with \"<f>\" via the
+`:annotation-function' property."
   (with-syntax-table emacs-lisp-mode-syntax-table
     (let* ((pos (point))
 	   (beg (condition-case nil