This is the sixth patch in a series that makes some straightforward corrections to a number of docstrings. Each change is normally to: - correct a typo, or - fix up hyperlinks to function or variable names, or - ensure slightly better conformance with the documentation guidelines and tips given in the Elisp manual No attempt is made to provide missing docstrings or document arguments. --- I have just seen Bernt's very helpful email about formatting patches in Git. Hopefully this will be easier to use for you. Please let me know if I have messed this formatting up. Phil lisp/org-timer.el | 10 +++++++--- lisp/org-w3m.el | 6 ++++-- lisp/org-wl.el | 6 +++--- lisp/org-xoxo.el | 5 +++-- 4 files changed, 17 insertions(+), 10 deletions(-) diff --git a/lisp/org-timer.el b/lisp/org-timer.el index e0817c8..d8e07d6 100644 --- a/lisp/org-timer.el +++ b/lisp/org-timer.el @@ -27,6 +27,8 @@ ;; This file contains the relative timer code for Org-mode +;;; Code: + (require 'org) (declare-function org-show-notification "org-clock" (parameters)) @@ -110,7 +112,8 @@ the region 0:00:00." (run-hooks 'org-timer-start-hook)))) (defun org-timer-pause-or-continue (&optional stop) - "Pause or continue the relative timer. With prefix arg, stop it entirely." + "Pause or continue the relative timer. +With prefix arg STOP, stop it entirely." (interactive "P") (cond (stop (org-timer-stop)) @@ -145,8 +148,9 @@ the region 0:00:00." (defun org-timer (&optional restart) "Insert a H:MM:SS string from the timer into the buffer. The first time this command is used, the timer is started. When used with -a `C-u' prefix, force restarting the timer. -When used with a double prefix arg `C-u C-u', change all the timer string +a \\[universal-argument] prefix, force restarting the timer. +When used with a double prefix argument \ +\\[universal-argument] \\universal-argument], change all the timer string in the region by a fixed amount. This can be used to recalibrate a timer that was not started at the correct moment." (interactive "P") diff --git a/lisp/org-w3m.el b/lisp/org-w3m.el index 3f403c9..ce28729 100644 --- a/lisp/org-w3m.el +++ b/lisp/org-w3m.el @@ -28,11 +28,11 @@ ;; This file implements copying HTML content from a w3m buffer and ;; transforming the text on the fly so that it can be pasted into ;; an org-mode buffer with hot links. It will also work for regions -;; in gnus buffers that have ben washed with w3m. +;; in gnus buffers that have been washed with w3m. ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ;; -;;; Acknowledgements: +;;; Acknowledgments: ;; Richard Riley ;; @@ -40,6 +40,8 @@ ;; proposed by Richard, I'm just coding it. ;; +;;; Code: + (require 'org) (defun org-w3m-copy-for-org-mode () diff --git a/lisp/org-wl.el b/lisp/org-wl.el index de6e919..9826a6f 100644 --- a/lisp/org-wl.el +++ b/lisp/org-wl.el @@ -105,7 +105,7 @@ googlegroups otherwise." '(("%" . imap) ("-" . nntp) ("+" . mh) ("=" . spool) ("$" . archive) ("&" . pop) ("@" . shimbun) ("[" . search) ("*" . multi) ("/" . filter) ("|" . pipe) ("'" . internal)) - "List of folder indicators. See Wanderlust manual, section 3.") + "List of folder indicators. See Wanderlust manual, section 3.") ;; Install the link type (org-add-link-type "wl" 'org-wl-open) @@ -114,8 +114,8 @@ googlegroups otherwise." ;; Implementation (defun org-wl-folder-type (folder) - "Return symbol that indicicates the type of FOLDER. -FOLDER is the wanderlust folder name. The first character of the + "Return symbol that indicates the type of FOLDER. +FOLDER is the wanderlust folder name. The first character of the folder name determines the the folder type." (let* ((indicator (substring folder 0 1)) (type (cdr (assoc indicator org-wl-folder-types)))) diff --git a/lisp/org-xoxo.el b/lisp/org-xoxo.el index 2ed5ff4..c065a8c 100644 --- a/lisp/org-xoxo.el +++ b/lisp/org-xoxo.el @@ -25,10 +25,11 @@ ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ;; ;;; Commentary: +;; XOXO export -(require 'org-exp) +;;; Code: -;;; XOXO export +(require 'org-exp) (defvar org-export-xoxo-final-hook nil "Hook run after XOXO export, in the new buffer.") -- 1.7.1.1