summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKyle Meyer <kyle@kyleam.com>2015-01-02 17:38:19 -0500
committerNicolas Goaziou <mail@nicolasgoaziou.fr>2015-01-03 12:15:50 +0100
commit424eb552635ee0480ca7039b08f271bfd7c63dad (patch)
tree0cc14cc67c056090d8cc86e7495a5f2ce0b53b47
parent10954832e5168c301e4c0d266089a5f77062212b (diff)
downloadorg-mode-424eb552635ee0480ca7039b08f271bfd7c63dad.tar.gz
org-agenda: Fix exiting function docstrings
* lisp/org-agenda.el (org-agenda-Quit): * lisp/org-agenda.el (org-agenda-quit): * lisp/org-agenda.el (org-agenda-exit): Correct and expand docstrings.
-rw-r--r--lisp/org-agenda.el24
1 files changed, 17 insertions, 7 deletions
diff --git a/lisp/org-agenda.el b/lisp/org-agenda.el
index 5990bbb..49eb07b 100644
--- a/lisp/org-agenda.el
+++ b/lisp/org-agenda.el
@@ -7173,8 +7173,9 @@ Allowed types are 'agenda 'timeline 'todo 'tags 'search."
nil))))
(defun org-agenda-Quit ()
- "Exit the agenda and kill buffers loaded by `org-agenda'.
-Also restore the window configuration."
+ "Exit the agenda, killing the agenda buffer.
+Like `org-agenda-quit', but kill the buffer even when
+`org-agenda-sticky' is non-nil."
(interactive)
(if org-agenda-columns-active
(org-columns-quit)
@@ -7202,8 +7203,16 @@ Also restore the window configuration."
(setq org-agenda-pre-window-conf nil))))
(defun org-agenda-quit ()
- "Exit the agenda and restore the window configuration.
-When `org-agenda-sticky' is non-nil, only bury the agenda."
+ "Exit the agenda.
+
+When `org-agenda-sticky' is non-nil, bury the agenda buffer
+instead of killing it.
+
+When `org-agenda-restore-windows-after-quit' is non-nil, restore
+the pre-agenda window configuration.
+
+When column view is active, exit column view instead of the
+agenda."
(interactive)
(if (and (eq org-indirect-buffer-display 'other-window)
org-last-indirect-buffer)
@@ -7232,9 +7241,10 @@ When `org-agenda-sticky' is non-nil, only bury the agenda."
(org-agenda-Quit))))
(defun org-agenda-exit ()
- "Exit the agenda and restore the window configuration.
-Also kill Org-mode buffers loaded by `org-agenda'. Org-mode
-buffers visited directly by the user will not be touched."
+ "Exit the agenda, killing Org buffers loaded by the agenda.
+Like `org-agenda-Quit', but kill any buffers that were created by
+the agenda. Org buffers visited directly by the user will not be
+touched."
(interactive)
(org-release-buffers org-agenda-new-buffers)
(setq org-agenda-new-buffers nil)