Bug: Docstring of `org-clock-persist' doesn't mention `history' [7.9.2 (7.9.2-90-ge5ea08-elpaplus @ /Users/gvol/vcs/emacs/local/nextstep/Emacs.app/Contents/Resources/lisp/org/)]

Bug: Docstring of `org-clock-persist' doesn't mention `history' [7.9.2 (7.9.2-90-ge5ea08-elpaplus @ /Users/gvol/vcs/emacs/local/nextstep/Emacs.app/Contents/Resources/lisp/org/)]

[Ivan Andrus]

Hello org maintainers,

The manual suggests setting `org-clock-persist' to 'history, but this value isn't documented in the docstring.  There is an explicit check for the value of history in `org-clock-save', so I think it should be documented since it's more than just a non-nil value.

Thanks,
Ivan


Emacs  : GNU Emacs 24.3.50.3 (i386-apple-darwin12.2.0, NS apple-appkit-1187.34)
of 2012-12-14 on oroszlan.local
Package: Org-mode version 7.9.2 (7.9.2-90-ge5ea08-elpaplus @ /Users/gvol/vcs/emacs/local/nextstep/Emacs.app/Contents/Resources/lisp/org/)

current state:
==============
(setq
org-hide-leading-stars t
org-export-preprocess-before-selecting-backend-code-hook '(org-beamer-select-beamer-code)
org-tab-first-hook '(org-hide-block-toggle-maybe org-src-native-tab-command-maybe
                      org-babel-hide-result-toggle-maybe
                      org-babel-header-arg-expand)
org-speed-command-hook '(org-speed-command-default-hook
                          org-babel-speed-command-hook)
org-ctrl-c-ctrl-c-final-hook '(decrypt-current-block)
org-occur-hook '(org-first-headline-recenter)
org-metaup-hook '(org-babel-load-in-session-maybe)
org-export-preprocess-before-normalizing-links-hook '(org-remove-file-link-modifiers)
org-confirm-shell-link-function 'yes-or-no-p
org-export-latex-final-hook '(org-beamer-amend-header org-beamer-fix-toc
                               org-beamer-auto-fragile-frames
                               org-beamer-place-default-actions-for-lists)
org-special-ctrl-a/e t
org-export-latex-after-initial-vars-hook '(org-beamer-after-initial-vars)
org-agenda-skip-scheduled-if-done t
org-agenda-custom-commands '(("t" "TODO today" todo "TODO"
                               ((org-agenda-sorting-strategy (quote (time-up))))
                               nil)
                              ("l" "TODO today" tags "LaTeX"
                               ((org-agenda-sorting-strategy
                                 (quote (priority-down)))
                                )
                               nil)
                              ("d" "dissertation" todo "Dissertation"
                               ((org-agenda-files
                                 (quote ("~/TeX/dissertation/todo.org")))
                                (org-agenda-sorting-strategy (quote (priority-up))))
                               nil)
                              ("v" "Creative" tags "creative"
                               ((org-agenda-sorting-strategy (quote (alpha-up))))
                               nil)
                              )
org-todo-keyword-faces '(("IDEA" :foreground "orange" :weight bold)
                          ("LATER" :foreground "orange" :weight bold)
                          ("WORKING" :foreground "orange" :weight bold))
org-after-todo-state-change-hook '(org-clock-out-if-current)
org-src-mode-hook '(org-src-babel-configure-edit-buffer
                     org-src-mode-configure-edit-buffer)
org-agenda-before-write-hook '(org-agenda-add-entry-text)
org-babel-pre-tangle-hook '(save-buffer)
org-export-copy-to-kill-ring nil
org-mode-hook '(er/add-org-mode-expansions
                 #[nil "\300\301\302\303\304$\207"
                   [add-hook before-save-hook org-encrypt-entries nil t] 5]
                 alth-auto-hook-org-mode-hook
                 #[nil "\300\301\302\303\304$\207"
                   [org-add-hook change-major-mode-hook org-show-block-all append
                    local]
                   5]
                 #[nil "\300\301\302\303\304$\207"
                   [org-add-hook change-major-mode-hook org-babel-show-result-all
                    append local]
                   5]
                 org-babel-result-hide-spec org-babel-hide-all-hashes)
org-export-with-tags 'not-in-toc
org-ctrl-c-ctrl-c-hook '(org-babel-hash-at-point org-babel-execute-safely-maybe)
org-directory "~"
org-cycle-hook '(org-cycle-hide-archived-subtrees org-cycle-hide-drawers
                  org-cycle-show-empty-lines
                  org-optimize-window-after-visibility-change)
org-tags-exclude-from-inheritance '("crypt")
org-export-latex-format-toc-function 'org-export-latex-format-toc-default
org-export-blocks '((src org-babel-exp-src-block nil)
                     (export-comment org-export-blocks-format-comment t)
                     (ditaa org-export-blocks-format-ditaa nil)
                     (dot org-export-blocks-format-dot nil))
org-archive-location "~/Documents/archive.org::From %s"
org-export-first-hook '(org-beamer-initialize-open-trackers)
org-export-interblocks '((src org-babel-exp-non-block-elements))
org-export-with-drawers nil
org-modules '(org-bbdb org-bibtex org-docview org-gnus org-info org-jsinfo org-irc
               org-mew org-mhe org-rmail org-vm org-w3m org-wl org-habit)
org-babel-tangle-lang-exts '(("python" . "py") ("emacs-lisp" . "el"))
org-confirm-elisp-link-function 'yes-or-no-p
org-metadown-hook '(org-babel-pop-to-session-maybe)
org-ditaa-jar-path "/Users/gvol/.emacs.d/elpa/contrib/scripts/ditaa.jar"
org-export-html-final-hook '(convert-to-wordpress-markup)
org-structure-template-alist '(("s" "#+BEGIN_SRC ?\n\n#+END_SRC"
                                 "<src lang=\"?\">\n\n</src>")
                                ("e" "#+BEGIN_EXAMPLE\n?\n#+END_EXAMPLE"
                                 "<example>\n?\n</example>")
                                ("q" "#+BEGIN_QUOTE\n?\n#+END_QUOTE"
                                 "<quote>\n?\n</quote>")
                                ("v" "#+BEGIN_VERSE\n?\n#+END_VERSE"
                                 "<verse>\n?\n</verse>")
                                ("c" "#+BEGIN_CENTER\n?\n#+END_CENTER"
                                 "<center>\n?\n</center>")
                                ("l" "#+BEGIN_LaTeX\n?\n#+END_LaTeX"
                                 "<literal style=\"latex\">\n?\n</literal>")
                                ("L" "#+LaTeX: "
                                 "<literal style=\"latex\">?</literal>")
                                ("h" "#+BEGIN_HTML\n?\n#+END_HTML"
                                 "<literal style=\"html\">\n?\n</literal>")
                                ("H" "#+HTML: "
                                 "<literal style=\"html\">?</literal>")
                                ("a" "#+BEGIN_ASCII\n?\n#+END_ASCII")
                                ("A" "#+ASCII: ") ("i" "#+INDEX: ?" "#+INDEX: ?")
                                ("I" "#+INCLUDE: %file ?"
                                 "<include file=%file markup=\"?\">")
                                )
org-mobile-directory "~/Sites/org"
org-beamer-fragile-re "\\\\\\(verb\\|lstinline\\|href\\)\\|^[ 	]*\\\\begin{\\(verbatim\\|lstlisting\\|minted\\)}"
org-feed-alist '(("SageTrac"
                   "http://trac.sagemath.org/sage_trac/report/34?format=rss&USER=iandrus" "~/SageStuff/trac.org" "Sage Trac Items" :template "\n* %h\n  %U\n  %a\n#+begin_src html\n  %description\n#+end_src\n")
                  ("SageGetReviewed"
                   "http://trac.sagemath.org/sage_trac/query?status=needs_review&format=rss&author=%7EAndrus&order=priority" "~/SageStuff/trac.org" "Get Reviewed" :template "\n* %h\n  %U\n  %a\n#+begin_src html\n  %description\n#+end_src\n")
                  ("SageWorkOn"
                   "http://trac.sagemath.org/sage_trac/query?status=needs_info&status=needs_work&status=new&owner=iandrus&format=rss" "~/SageStuff/trac.org" "Work On" :template "\n* %h\n  %U\n  %a\n#+begin_src html\n  %description\n#+end_src\n")
                  ("SageReview"
                   "http://trac.sagemath.org/sage_trac/query?status=needs_review&format=rss&cc=%7Eiandrus&author=%21%7Eandrus&order=priority" "~/SageStuff/trac.org" "Review These" :template "\n* %h\n  %U\n  %a\n#+begin_src html\n  %description\n#+end_src\n")
                  ("SageFollow"
                   "http://trac.sagemath.org/sage_trac/query?status=needs_info&status=needs_work&status=new&format=rss&cc=%7Eiandrus&order=priority" "~/SageStuff/trac.org" "Follow" :template "\n* %h\n  %U\n  %a\n#+begin_src html\n  %description\n#+end_src\n")
                  )
org-reveal-start-hook '(org-decrypt-entry)
org-agenda-files '("~/todo.org" "~/TeX/dissertation/todo.org"
                    "~/SageStuff/trac.org")
org-clock-out-hook '(org-clock-remove-empty-clock-drawer)
org-mobile-inbox-for-pull "~/todo.org"
org-src-fontify-natively t
)

Re: Bug: Docstring of `org-clock-persist' doesn't mention `history' [7.9.2 (7.9.2-90-ge5ea08-elpaplus @ /Users/gvol/vcs/emacs/local/nextstep/Emacs.app/Contents/Resources/lisp/org/)]

[Bastien]

Hi Ivan,

Ivan Andrus <darthandrus@gmail.com> writes:

> The manual suggests setting `org-clock-persist' to 'history, but this
> value isn't documented in the docstring.  There is an explicit check
> for the value of history in `org-clock-save', so I think it should be
> documented since it's more than just a non-nil value.

Indeed.  Fixed, thanks for reporting this.

-- 
 Bastien