summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNicolas Goaziou <mail@nicolasgoaziou.fr>2016-01-03 20:48:14 +0100
committerNicolas Goaziou <mail@nicolasgoaziou.fr>2016-01-03 20:48:14 +0100
commit3d4c4676737b3516adf9a12f03dd1ed7b67e3477 (patch)
tree620e24afbd03552af0d40128e2044b27b3a2cd07
parenta03175d6d971764de33c521a95bca1c6f35943e2 (diff)
downloadorg-mode-3d4c4676737b3516adf9a12f03dd1ed7b67e3477.tar.gz
org-clock: Improve docstring
* lisp/org-clock.el (org-clock-display): Point to `org-clock-display-default-range'. Reported-by: David Bremner <david@tethera.net> <http://permalink.gmane.org/gmane.emacs.orgmode/103938>
-rw-r--r--lisp/org-clock.el12
1 files changed, 8 insertions, 4 deletions
diff --git a/lisp/org-clock.el b/lisp/org-clock.el
index 09f8391..f6ca89d 100644
--- a/lisp/org-clock.el
+++ b/lisp/org-clock.el
@@ -1895,10 +1895,14 @@ PROPNAME lets you set a custom text property instead of :org-clock-minutes."
(defun org-clock-display (&optional arg)
"Show subtree times in the entire buffer.
-With one universal prefix argument, show the total time for
-today. With two universal prefix arguments, show the total time
-for a custom range, entered at the prompt. With three universal
-prefix arguments, show the total time in the echo area.
+By default, show the total time for the range defined in
+`org-clock-display-default-range'. With \\[universal-argument] \
+prefix, show
+the total time for today instead. With \\[universal-argument] \
+\\[universal-argument] prefix, use
+a custom range, entered at the prompt. With \\[universal-argument] \
+\\[universal-argument] \\[universal-argument]
+prefix, display the total time in the echo area.
Use \\[org-clock-remove-overlays] to remove the subtree times."
(interactive "P")