diff options
author | Nicolas Goaziou <mail@nicolasgoaziou.fr> | 2015-05-13 12:35:24 +0200 |
---|---|---|
committer | Nicolas Goaziou <mail@nicolasgoaziou.fr> | 2015-05-13 12:35:24 +0200 |
commit | 0e7062678eb224027e5eca70a205430083a13a64 (patch) | |
tree | 154136f6deb05200ad69e1803e8d2562590a51ef | |
parent | d0fab8bb6f70d4fa83f28130f883315126caff05 (diff) | |
download | org-mode-0e7062678eb224027e5eca70a205430083a13a64.tar.gz |
Improve docstrings
* lisp/org.el (org-metaleft):
(org-metaright): Improve docstrings.
Suggested-by: Alain Cochard <Alain.Cochard@unistra.fr>
<http://permalink.gmane.org/gmane.emacs.orgmode/97509>
-rwxr-xr-x | lisp/org.el | 24 |
1 files changed, 18 insertions, 6 deletions
diff --git a/lisp/org.el b/lisp/org.el index ac9d06d..4b44a94 100755 --- a/lisp/org.el +++ b/lisp/org.el @@ -20477,10 +20477,15 @@ Everywhere else, drag the line at point down." "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>")) (defun org-metaleft (&optional arg) - "Promote heading or move table column to left. -Calls `org-do-promote' or `org-table-move-column', depending on context. -With no specific context, calls the Emacs default `backward-word'. -See the individual commands for more information." + "Promote heading, list item at point or move table column left. + +Calls `org-do-promote', `org-outdent-item' or `org-table-move-column', +depending on context. With no specific context, calls the Emacs +default `backward-word'. See the individual commands for more +information. + +This function runs the hook `org-metaleft-hook' as a first step, +and returns at first non-nil value." (interactive "P") (cond ((run-hook-with-args-until-success 'org-metaleft-hook)) @@ -20506,10 +20511,17 @@ See the individual commands for more information." (t (call-interactively 'backward-word)))) (defun org-metaright (&optional arg) - "Demote a subtree, a list item or move table column to right. + "Demote heading, list item at point or move table column right. + In front of a drawer or a block keyword, indent it correctly. + +Calls `org-do-demote', `org-indent-item', `org-table-move-column', +`org-indnet-drawer' or `org-indent-block' depending on context. With no specific context, calls the Emacs default `forward-word'. -See the individual commands for more information." +See the individual commands for more information. + +This function runs the hook `org-metaright-hook' as a first step, +and returns at first non-nil value." (interactive "P") (cond ((run-hook-with-args-until-success 'org-metaright-hook)) |