[elpa] externals/olivetti dd9162f 112/134: Documentation improvements

[Stefan Monnier]

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

    Documentation improvements
---
 olivetti.el | 14 ++++++++++++--
 1 file changed, 12 insertions(+), 2 deletions(-)

diff --git a/olivetti.el b/olivetti.el
index 19ab010..eb1f6d8 100644
--- a/olivetti.el
+++ b/olivetti.el
@@ -239,7 +239,14 @@ then rerun.
 If ARG is 'exit, kill `mode-line-format' then rerun.
 
 If ARG is nil and `olivetti-hide-mode-line' is non-nil, hide the
-mode line."
+mode line.
+
+To explicitly set the mode line in Lisp code, do something like
+the following:
+
+    (let ((olivetti-hide-mode-line t))
+      (olivetti-set-mode-line))
+"
   (cond ((eq arg 'toggle)
          (setq olivetti-hide-mode-line
                (not olivetti-hide-mode-line))
@@ -254,7 +261,10 @@ mode line."
   "Toggle the visibility of the mode-line.
 
 Toggles the value of `olivetti-hide-mode-line' and runs
-`olivetti-set-mode-line'."
+`olivetti-set-mode-line'.
+
+n.b. This command is probably not what you want in Lisp code. See
+instead `olivetti-set-mode-line'."
   (interactive)
   (olivetti-set-mode-line 'toggle))