[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/olivetti dd9162f 112/134: Documentation improvements
From: |
Stefan Monnier |
Subject: |
[elpa] externals/olivetti dd9162f 112/134: Documentation improvements |
Date: |
Thu, 25 Apr 2019 09:57:39 -0400 (EDT) |
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))
- [elpa] externals/olivetti 26f3db0 050/134: Updated README/Commentary, (continued)
- [elpa] externals/olivetti 26f3db0 050/134: Updated README/Commentary, Stefan Monnier, 2019/04/25
- [elpa] externals/olivetti 66bdcc7 057/134: lexical-binding: t, Stefan Monnier, 2019/04/25
- [elpa] externals/olivetti f53b5f4 062/134: Added mode-map, Stefan Monnier, 2019/04/25
- [elpa] externals/olivetti ce4c9f0 068/134: Document split-window-right workaround, Stefan Monnier, 2019/04/25
- [elpa] externals/olivetti 9d318be 069/134: Added README to Commentary, Stefan Monnier, 2019/04/25
- [elpa] externals/olivetti d2c54ac 072/134: Add change-major-mode-hook to reset margins, Stefan Monnier, 2019/04/25
- [elpa] externals/olivetti 5ac4444 085/134: Use GitHub repo screenshot, Stefan Monnier, 2019/04/25
- [elpa] externals/olivetti cefceed 089/134: Added note about buggy display-line-numbers-mode, Stefan Monnier, 2019/04/25
- [elpa] externals/olivetti 9d9f9ce 090/134: Added hints, Stefan Monnier, 2019/04/25
- [elpa] externals/olivetti 988d326 092/134: Use HTTPS for README links, Stefan Monnier, 2019/04/25
- [elpa] externals/olivetti dd9162f 112/134: Documentation improvements,
Stefan Monnier <=
- [elpa] externals/olivetti 3facf2b 115/134: Change hooks:, Stefan Monnier, 2019/04/25
- [elpa] externals/olivetti e70adca 121/134: Add safe custom variable properties, Stefan Monnier, 2019/04/25
- [elpa] externals/olivetti 3df740c 122/134: Change top-level customization group wp -> text, Stefan Monnier, 2019/04/25
- [elpa] externals/olivetti 2304ddc 124/134: Refactoring style: if -> when for condition cases without else, Stefan Monnier, 2019/04/25
- [elpa] externals/olivetti 687f2df 129/134: Require Emacs 24.5, Stefan Monnier, 2019/04/25
- [elpa] externals/olivetti 506b1d9 132/134: Update README/Commentary -- add Emacs 27.x window.c bug, Stefan Monnier, 2019/04/25
- [elpa] externals/olivetti 6917a16 130/134: Remove olivetti-hide-mode-line function & related code, Stefan Monnier, 2019/04/25