[elpa] externals/olivetti 34b8a54 032/134: Added doc string

[Stefan Monnier]

branch: externals/olivetti
commit 34b8a54b51b83b55975d53e8aef8c1deee37b96d
Author: Paul Rankin <address@hidden>
Commit: Paul Rankin <address@hidden>

    Added doc string
---
 olivetti.el | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/olivetti.el b/olivetti.el
index cbd6329..184179e 100644
--- a/olivetti.el
+++ b/olivetti.el
@@ -134,6 +134,10 @@ mode line. Finally redraw the frame."
   (redraw-frame (selected-frame)))
 
 (defun olivetti-scale-width (n)
+  "Scale N in accordance with the face height.
+For compatibility with `text-scale-mode', if
+`face-remapping-alist' includes a :height property on the default
+face, scale N by that factor, otherwise scale by 1."
   (let ((face-height (or (plist-get (cadr (assoc 'default
                                                  face-remapping-alist))
                                     :height)