[Emacs-diffs] trunk r116595: Some doc fixes for completion-hilit-commonality and friends

[Glenn Morris]

------------------------------------------------------------
revno: 116595
revision-id: address@hidden
parent: address@hidden
committer: Glenn Morris <address@hidden>
branch nick: trunk
timestamp: Thu 2014-02-27 21:29:45 -0800
message:
  Some doc fixes for completion-hilit-commonality and friends
  
  * lisp/minibuffer.el (completions-first-difference)
  (completions-common-part, completion-hilit-commonality): Doc fixes.
modified:
  lisp/ChangeLog                 changelog-20091113204419-o5vbwnq5f7feedwu-1432
  lisp/minibuffer.el             
minibuffer.el-20091113204419-o5vbwnq5f7feedwu-8622

=== modified file 'lisp/ChangeLog'
--- a/lisp/ChangeLog    2014-02-28 02:13:56 +0000
+++ b/lisp/ChangeLog    2014-02-28 05:29:45 +0000
@@ -1,3 +1,8 @@
+2014-02-28  Glenn Morris  <address@hidden>
+
+       * minibuffer.el (completions-first-difference)
+       (completions-common-part, completion-hilit-commonality): Doc fixes.
+
 2014-02-28  Karl Berry  <address@hidden>
 
        * info.el (Info-mode-map): Add H for describe-mode,

=== modified file 'lisp/minibuffer.el'
--- a/lisp/minibuffer.el        2014-02-27 08:01:22 +0000
+++ b/lisp/minibuffer.el        2014-02-28 05:29:45 +0000
@@ -1576,15 +1576,26 @@
 
 (defface completions-first-difference
   '((t (:inherit bold)))
-  "Face added on the first uncommon character in completions in *Completions* 
buffer.")
+  "Face for the first uncommon character in completions.
+See also the face `completions-common-part'.")
 
 (defface completions-common-part '((t nil))
-  "Face added on the common prefix substring in completions in *Completions* 
buffer.
-The idea of `completions-common-part' is that you can use it to
-make the common parts less visible than normal, so that the rest
-of the differing parts is, by contrast, slightly highlighted.")
+  "Face for the common prefix substring in completions.
+The idea of this face is that you can use it to make the common parts
+less visible than normal, so that the differing parts are emphasized
+by contrast.
+See also the face `completions-first-difference'.")
 
 (defun completion-hilit-commonality (completions prefix-len base-size)
+  "Apply font-lock highlighting to a list of completions, COMPLETIONS.
+PREFIX-LEN is an integer.  BASE-SIZE is an integer or nil (meaning zero).
+
+This adds the face `completions-common-part' to the first
+\(PREFIX-LEN - BASE-SIZE) characters of each completion, and the face
+`completions-first-difference' to the first character after that.
+
+It returns a list with font-lock properties applied to each element,
+and with BASE-SIZE appended as the last element."
   (when completions
     (let ((com-str-len (- prefix-len (or base-size 0))))
       (nconc