diff options
| author | Chong Yidong | 2012-04-04 17:19:32 +0800 |
|---|---|---|
| committer | Chong Yidong | 2012-04-04 17:19:32 +0800 |
| commit | 321cc491c5843ee3af86570d5b2d59b98ba0c422 (patch) | |
| tree | 118c8469015212fc05c255de56d2b72eba2be128 /lisp | |
| parent | a7972adfd8c545a603e395153ba6537e6d573864 (diff) | |
| download | emacs-321cc491c5843ee3af86570d5b2d59b98ba0c422.tar.gz emacs-321cc491c5843ee3af86570d5b2d59b98ba0c422.zip | |
Document completion-extra-properties in Lisp manual.
* doc/lispref/minibuf.texi (Programmed Completion): Remove obsolete variable
completion-annotate-function.
(Completion Variables): Rename from Completion Styles. Document
completion-extra-properties. Document completion-styles-alist
change.
* lisp/minibuffer.el (completion-extra-properties): Doc fix.
Diffstat (limited to 'lisp')
| -rw-r--r-- | lisp/ChangeLog | 2 | ||||
| -rw-r--r-- | lisp/minibuffer.el | 27 |
2 files changed, 19 insertions, 10 deletions
diff --git a/lisp/ChangeLog b/lisp/ChangeLog index 32bdd8630ca..64177b03c47 100644 --- a/lisp/ChangeLog +++ b/lisp/ChangeLog | |||
| @@ -1,5 +1,7 @@ | |||
| 1 | 2012-04-04 Chong Yidong <cyd@gnu.org> | 1 | 2012-04-04 Chong Yidong <cyd@gnu.org> |
| 2 | 2 | ||
| 3 | * minibuffer.el (completion-extra-properties): Doc fix. | ||
| 4 | |||
| 3 | * subr.el (delayed-warnings-hook): Doc fix. | 5 | * subr.el (delayed-warnings-hook): Doc fix. |
| 4 | 6 | ||
| 5 | 2012-04-04 Daiki Ueno <ueno@unixuser.org> | 7 | 2012-04-04 Daiki Ueno <ueno@unixuser.org> |
diff --git a/lisp/minibuffer.el b/lisp/minibuffer.el index 6a6bba13523..bcc6a808d22 100644 --- a/lisp/minibuffer.el +++ b/lisp/minibuffer.el | |||
| @@ -1269,17 +1269,24 @@ the completions buffer." | |||
| 1269 | (defvar completion-extra-properties nil | 1269 | (defvar completion-extra-properties nil |
| 1270 | "Property list of extra properties of the current completion job. | 1270 | "Property list of extra properties of the current completion job. |
| 1271 | These include: | 1271 | These include: |
| 1272 | `:annotation-function': Function to add annotations in the completions buffer. | 1272 | |
| 1273 | The function takes a completion and should either return nil, or a string | 1273 | `:annotation-function': Function to annotate the completions buffer. |
| 1274 | that will be displayed next to the completion. The function can access the | 1274 | The function must accept one argument, a completion string, |
| 1275 | completion data via `minibuffer-completion-table' and related variables. | 1275 | and return either nil or a string which is to be displayed |
| 1276 | next to the completion (but which is not part of the | ||
| 1277 | completion). The function can access the completion data via | ||
| 1278 | `minibuffer-completion-table' and related variables. | ||
| 1279 | |||
| 1276 | `:exit-function': Function to run after completion is performed. | 1280 | `:exit-function': Function to run after completion is performed. |
| 1277 | The function takes at least 2 parameters (STRING and STATUS) where STRING | 1281 | |
| 1278 | is the text to which the field was completed and STATUS indicates what | 1282 | The function must accept two arguments, STRING and STATUS. |
| 1279 | kind of operation happened: if text is now complete it's `finished', if text | 1283 | STRING is the text to which the field was completed, and |
| 1280 | cannot be further completed but completion is not finished, it's `sole', if | 1284 | STATUS indicates what kind of operation happened: |
| 1281 | text is a valid completion but may be further completed, it's `exact', and | 1285 | `finished' - text is now complete |
| 1282 | other STATUSes may be added in the future.") | 1286 | `sole' - text cannot be further completed but |
| 1287 | completion is not finished | ||
| 1288 | `exact' - text is a valid completion but may be further | ||
| 1289 | completed.") | ||
| 1283 | 1290 | ||
| 1284 | (defvar completion-annotate-function | 1291 | (defvar completion-annotate-function |
| 1285 | nil | 1292 | nil |