[Emacs-diffs] /srv/bzr/emacs/trunk r112862: (prog-prettify-symbols) (prog-prettify-install): Update docstrings.

[Ted Zlatanov]

------------------------------------------------------------
revno: 112862
committer: Ted Zlatanov <address@hidden>
branch nick: quickfixes
timestamp: Wed 2013-06-05 14:30:47 -0400
message:
  (prog-prettify-symbols) (prog-prettify-install): Update docstrings.
modified:
  lisp/ChangeLog
  lisp/progmodes/prog-mode.el

=== modified file 'lisp/ChangeLog'
--- a/lisp/ChangeLog    2013-06-05 18:10:27 +0000
+++ b/lisp/ChangeLog    2013-06-05 18:30:47 +0000
@@ -1,3 +1,8 @@
+2013-06-05  Teodor Zlatanov  <address@hidden>
+
+       * progmodes/prog-mode.el (prog-prettify-symbols)
+       (prog-prettify-install): Update docstrings.
+
 2013-06-05  Stefan Monnier  <address@hidden>
 
        * simple.el: Move all the prog-mode code to prog-mode.el.

=== modified file 'lisp/progmodes/prog-mode.el'
--- a/lisp/progmodes/prog-mode.el       2013-06-05 18:10:27 +0000
+++ b/lisp/progmodes/prog-mode.el       2013-06-05 18:30:47 +0000
@@ -58,8 +58,8 @@
 
 (defcustom prog-prettify-symbols nil
   "Whether symbols should be prettified.
-When set to an alist in the form `(STRING . CHARACTER)' it will
-augment the mode's native prettify alist."
+When set to an alist in the form `((STRING . CHARACTER)...)' it
+will augment the mode's native prettify alist."
   :type '(choice
           (const :tag "No thanks" nil)
           (const :tag "Mode defaults" t)
@@ -96,6 +96,12 @@
          (0 (prog--prettify-font-lock-compose-symbol ',alist)))))))
 
 (defun prog-prettify-install (alist)
+"Install prog-mode support to prettify symbols according to ALIST.
+
+ALIST is in the format `((STRING . CHARACTER)...)' like
+`prog-prettify-symbols'.
+
+Internally, `font-lock-add-keywords' is called."
   (setq-local prog-prettify-symbols-alist alist)
   (let ((keywords (prog-prettify-font-lock-symbols-keywords)))
     (if keywords (font-lock-add-keywords nil keywords))))