[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[elpa] externals/orgalist f4e97b2: Improve minor mode's docstring

From: Nicolas Goaziou
Subject: [elpa] externals/orgalist f4e97b2: Improve minor mode's docstring
Date: Wed, 2 May 2018 19:16:48 -0400 (EDT)

branch: externals/orgalist
commit f4e97b2bff65aed2dcb0bb3b470d0f5c8c028e1e
Author: Nicolas Goaziou <address@hidden>
Commit: Nicolas Goaziou <address@hidden>

    Improve minor mode's docstring
    * orgalist.el (orgalist-mode):Improve docstring.
 orgalist.el | 24 +++++++++++++++++++++---
 1 file changed, 21 insertions(+), 3 deletions(-)

diff --git a/orgalist.el b/orgalist.el
index be36dfe..321f5f3 100644
--- a/orgalist.el
+++ b/orgalist.el
@@ -648,10 +648,28 @@ This function is meant to be used as a piece of advice on
 (define-minor-mode orgalist-mode
-  "Toggle the minor mode `orgalist-mode'.
+  "Toggle Org-like lists and their relative commands.
-This mode is for using Org mode plain lists commands in other
-major modes.
+With a prefix argument ARG, enable Auto Fill mode if ARG is
+positive, and disable it otherwise.  If called from Lisp, enable
+the mode if ARG is omitted or nil.
+When Orgalist mode is enabled, any line beginning with \"-\",
+\"+\", \"1.\" or \"a.\" followed by a space starts a list.  You
+can then operate locally on the list, e.g., to insert new items,
+move items or sort them.  See below for details.
+Moreover, you can add check-boxes to items
+  - [ ] A checkbox, toggled with `C-c C-c'
+turn an unordered list into a description list
+  - term :: description
+and control numbering in an ordered list
+  4. address@hidden a forced numbered item
 key             binding
 ---             -------

reply via email to

[Prev in Thread] Current Thread [Next in Thread]