From mboxrd@z Thu Jan 1 00:00:00 1970 From: Philip Rooke Subject: [PATCH] Docstring fixes Date: Sun, 18 Jul 2010 14:14:45 +0100 Message-ID: Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="===============1934133841==" Return-path: Received: from [140.186.70.92] (port=58348 helo=eggs.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1OaThi-0004JT-Do for emacs-orgmode@gnu.org; Sun, 18 Jul 2010 09:14:51 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.69) (envelope-from ) id 1OaThg-0002tb-QN for emacs-orgmode@gnu.org; Sun, 18 Jul 2010 09:14:50 -0400 Received: from mail-fx0-f41.google.com ([209.85.161.41]:56328) by eggs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1OaThg-0002tN-F9 for emacs-orgmode@gnu.org; Sun, 18 Jul 2010 09:14:48 -0400 Received: by fxm20 with SMTP id 20so1955317fxm.0 for ; Sun, 18 Jul 2010 06:14:45 -0700 (PDT) List-Id: "General discussions about Org-mode." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org Errors-To: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org To: emacs-orgmode@gnu.org --===============1934133841== Content-Type: multipart/alternative; boundary=001636c5b20a6290bc048ba93c9c --001636c5b20a6290bc048ba93c9c Content-Type: text/plain; charset=ISO-8859-1 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 --001636c5b20a6290bc048ba93c9c Content-Type: text/html; charset=ISO-8859-1 Content-Transfer-Encoding: quoted-printable
This is the sixth patch in a series that makes some straightforward
corrections to a number of docstrings. =A0Each change is normally t= o:

- correct a typo, or
- fix up hyperli= nks to function or variable names, or
- ensure slightly better conformance with the documentation guidelines=
=A0=A0and 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. =A0Hopefully this will be= easier to use for you. =A0Please let me know
if I have messed th= is formatting up.

Phil

=A0lisp/org-timer.el | = =A0 10 +++++++---
=A0lisp/org-w3m.el =A0 | =A0 =A06 ++++--
<= div>=A0lisp/org-wl.el =A0 =A0| =A0 =A06 +++---
=A0lisp/org-xoxo.e= l =A0| =A0 =A05 +++--
=A04 files changed, 17 insertions(+), 10 deletions(-)

<= div>diff --git a/lisp/org-timer.el b/lisp/org-timer.el
index e081= 7c8..d8e07d6 100644
--- a/lisp/org-timer.el
+++ b/lisp/= org-timer.el
@@ -27,6 +27,8 @@
=A0
=A0;; This file contains the= relative timer code for Org-mode
=A0
+;;; Code:
<= div>+
=A0(require 'org)
=A0
=A0(declare-f= unction org-show-notification "org-clock" (parameters))
@@ -110,7 +112,8 @@ the region 0:00:00."
=A0=A0 =A0 =A0= (run-hooks 'org-timer-start-hook))))
=A0
=A0(defun= org-timer-pause-or-continue (&optional stop)
- =A0"Paus= e or continue the relative timer. =A0With prefix arg, stop it entirely.&quo= t;
+ =A0"Pause or continue the relative timer.
+With prefi= x arg STOP, stop it entirely."
=A0=A0 (interactive "P&q= uot;)
=A0=A0 (cond
=A0=A0 =A0(stop (org-timer-stop))
@@ -145,8 +148,9 @@ the region 0:00:00."
=A0(defun org-timer (&optional restart)
=A0=A0 "Ins= ert a H:MM:SS string from the timer into the buffer.
=A0The first= time this command is used, the timer is started. =A0When used with
-a `C-u' prefix, force restarting the timer.
-When used with a double prefix arg `C-u C-u', change all the time= r string
+a \\[universal-argument] prefix, force restarting the t= imer.
+When used with a double prefix argument \
+\\[un= iversal-argument] \\universal-argument], change all the timer string
=A0in the region by a fixed amount. =A0This can be used to recalibrate= a timer
=A0that was not started at the correct moment."
=A0=A0 (interactive "P")
diff --git a/lisp/org-w= 3m.el b/lisp/org-w3m.el
index 3f403c9..ce28729 100644
--- a/lisp/org-w3m.el
+++ b/lisp/org-w3m.el
@@ -28,11 +28,11 @@
=A0;; This = file implements copying HTML content from a w3m buffer and
=A0;; = transforming the text on the fly so that it can be pasted into
=A0;; an org-mode buffer with hot links. =A0It will also work for regi= ons
-;; in gnus buffers that have ben washed with w3m.
= +;; in gnus buffers that have been washed with w3m.
=A0
=A0;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;= ;;;;;;
=A0;;
-;;; Acknowledgements:
+;;; Acknowledgments:=
=A0
=A0;; Richard Riley <rileyrgdev at googlemail d= ot com>
=A0;;
@@ -40,6 +40,8 @@
=A0;; =A0 = =A0 =A0proposed by Richard, I'm just coding it.
=A0;;
=A0
+;;; Code:
+
=A0(req= uire 'org)
=A0
=A0(defun org-w3m-copy-for-org-mode = ()
diff --git a/lisp/org-wl.el b/lisp/org-wl.el
index d= e6e919..9826a6f 100644
--- a/lisp/org-wl.el
+++ b/lisp/org-wl.el
@@ -105,= 7 +105,7 @@ googlegroups otherwise."
=A0=A0 '(("%&q= uot; . imap) ("-" . nntp) ("+" . mh) ("=3D" .= spool)
=A0=A0 =A0 ("$" . archive) ("&" . pop) ("= @" . shimbun) ("[" . search)
=A0=A0 =A0 ("*&q= uot; . multi) ("/" . filter) ("|" . pipe) ("'&= quot; . internal))
- =A0"List of folder indicators. See Wanderlust manual, section 3= .")
+ =A0"List of folder indicators. =A0See Wanderlust = manual, section 3.")
=A0
=A0;; Install the link ty= pe
=A0(org-add-link-type "wl" 'org-wl-open)
@@ -1= 14,8 +114,8 @@ googlegroups otherwise."
=A0;; Implementation=
=A0
=A0(defun org-wl-folder-type (folder)
- = =A0"Return symbol that indicicates the type of FOLDER.
-FOLDER is the wanderlust folder name. The first character of the
+ =A0"Return symbol that indicates the type of FOLDER.
+FOLDER is the wanderlust folder name. =A0The first character of the
=A0folder name determines the the folder type."
=A0=A0 = (let* ((indicator (substring folder 0 1))
=A0 (type (cdr (assoc indicator o= rg-wl-folder-types))))
diff --git a/lisp/org-xoxo.el b/lisp/org-xoxo.el
index 2ed5f= f4..c065a8c 100644
--- a/lisp/org-xoxo.el
+++ b/lisp/or= g-xoxo.el
@@ -25,10 +25,11 @@
=A0;;;;;;;;;;;;;;;;;;;;;;= ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
=A0;;
=A0;;; Commentary:
+;; XOXO export
=A0
-(require 'org-exp)
+;;; Code:
=A0
-;;; XOXO export
+(require 'org-exp)
=A0
=A0(defvar org-export-xoxo-final-hook nil
=A0=A0 "Hook run a= fter XOXO export, in the new buffer.")
--=A0
1.7.1= .1

--001636c5b20a6290bc048ba93c9c-- --===============1934133841== Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Content-Disposition: inline _______________________________________________ Emacs-orgmode mailing list Please use `Reply All' to send replies to the list. Emacs-orgmode@gnu.org http://lists.gnu.org/mailman/listinfo/emacs-orgmode --===============1934133841==--