Bug: org-clock-display should mention how to remove times [6.33x]

Bug: org-clock-display should mention how to remove times [6.33x]

[Reiner Steib]

Hi,

| <menu-bar> <Org> <Logging work> <Display times> runs the command
| org-clock-display, which is an interactive compiled Lisp function in
| `org-clock.el'.
|
| It is bound to C-c C-x C-d, <menu-bar> <Org> <Logging work> <Display times>.
|
| (org-clock-display &optional TOTAL-ONLY)
|
| Show subtree times in the entire buffer.
| If TOTAL-ONLY is non-nil, only show the total time for the entire file
| in the echo area.

The doc string of `org-clock-display' should mention how to get rid of
the subtree times.

From the code, I guess it is `org-clock-remove-overlays'...

--8<---------------cut here---------------start------------->8---
2011-02-25  Reiner Steib  <reiner.steib@gmx.de>

	* org-clock.el (org-clock-display): Document how to remove subtree
	times.
--8<---------------cut here---------------end--------------->8---

--8<---------------cut here---------------start------------->8---
--- lisp/org/org-clock.el	Fri Feb 25 14:27:00 2011
+++ lisp/org/org-clock.el~	Sat Jan 08 12:45:14 2011
@@ -1282,9 +1282,7 @@
 (defun org-clock-display (&optional total-only)
   "Show subtree times in the entire buffer.
 If TOTAL-ONLY is non-nil, only show the total time for the entire file
-in the echo area.
-
-Use \\[org-clock-remove-overlays] to remove the subtree times."
+in the echo area."
   (interactive)
   (org-clock-remove-overlays)
   (let (time h m p)
--8<---------------cut here---------------end--------------->8---

Emacs  : GNU Emacs 23.2.93.1 (i386-mingw-nt6.0.6002)
 of 2011-02-01 on 3249CTO
Package: Org-mode version 6.33x

current state:
==============
(setq
 org-after-todo-state-change-hook '(org-clock-out-if-current)
 org-export-preprocess-hook '(org-export-blocks-preprocess)
 org-tab-first-hook '(org-hide-block-toggle-maybe)
 org-src-mode-hook '(org-src-mode-configure-edit-buffer)
 org-confirm-shell-link-function 'yes-or-no-p
 org-agenda-before-write-hook '(org-agenda-add-entry-text)
 org-cycle-hook '(org-cycle-hide-archived-subtrees  org-cycle-hide-drawers
org-cycle-show-empty-lines
		  org-optimize-window-after-visibility-change)
 org-mode-hook '(#[nil "..." [org-add-hook change-major-mode-hook
org-show-block-all append local] 5]
		 org-indent-mode show-all ruv-org-mode-hook)
 org-confirm-elisp-link-function 'yes-or-no-p
 org-indent-indentation-per-level 1
 org-occur-hook '(org-first-headline-recenter)
 )

Bye, Reiner.
-- 
       ,,,
      (o o)
---ooO-(_)-Ooo---  |  PGP key available  |  http://rsteib.home.pages.de/

Re: Bug: org-clock-display should mention how to remove times [6.33x]

[Bastien]

Hi Rainer,

Reiner Steib <reinersteib+gmane@imap.cc> writes:

>From the code, I guess it is `org-clock-remove-overlays'...
>
> 2011-02-25  Reiner Steib  <reiner.steib@gmx.de>
>
> 	* org-clock.el (org-clock-display): Document how to remove subtree
> 	times.

Applied against latest git Org, thanks.

-- 
 Bastien