Re: [Orgmode] [PATCH] Correct some docstrings [part 2]

[Carsten Dominik]

Accepted, with minor reversals.

- Carsten

On Jul 15, 2010, at 7:54 PM, Philip Rooke wrote:



This is a second 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.


Cheers,

Phil

--

lisp/org-docbook.el|8 +++---
lisp/org-docview.el|   11 ++--
lisp/org-entities.el   |8 --
lisp/org-exp-blocks.el |   58 +++ 
+

lisp/org-exp.el|   29 ++--
lisp/org-feed.el   |4 +-
lisp/org-freemind.el   |   14 +-
lisp/org-habit.el  |3 ++
lisp/org-html.el   |   56  
+

9 files changed, 106 insertions(+), 85 deletions(-)

diff --git a/lisp/org-docbook.el b/lisp/org-docbook.el
index bbd0bed..c136d20 100644
--- a/lisp/org-docbook.el
+++ b/lisp/org-docbook.el
@@ -26,7 +26,7 @@
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs.  If not, see .

-;; Commentary:
+;;; Commentary:
;;
;; This library implements a DocBook exporter for org-mode.  The basic
;; idea and design is very similar to what `org-export-as-html' has.
@@ -142,8 +142,8 @@ people work on the same document."
  :type 'string)

(defcustom org-export-docbook-footnote-id-prefix "fn-"
-  "The prefix of footnote IDs used during exporting.  Like
-`org-export-docbook-section-id-prefix', this variable can help
+  "The prefix of footnote IDs used during exporting.
+Like `org-export-docbook-section-id-prefix', this variable can help
avoid same set of footnote IDs being used multiple times."
  :group 'org-export-docbook
  :type 'string)
@@ -155,7 +155,7 @@ avoid same set of footnote IDs being used  
multiple times."

("=" "" "")
("~" "" "")
("+" "" ""))
-  "Alist of DocBook expressions to convert emphasis fontifiers.
+  "A list of DocBook expressions to convert emphasis fontifiers.
Each element of the list is a list of three elements.
The first element is the character used as a marker for fontification.
The second element is a formatting string to wrap fontified text with.
diff --git a/lisp/org-docview.el b/lisp/org-docview.el
index 5db6594..b3a5178 100644
--- a/lisp/org-docview.el
+++ b/lisp/org-docview.el
@@ -62,7 +62,7 @@
  )))

(defun org-docview-store-link ()
-  "Store a link to a docview buffer"
+  "Store a link to a docview buffer."
  (when (eq major-mode 'doc-view-mode)
;; This buffer is in doc-view-mode
(let* ((path buffer-file-name)
@@ -75,11 +75,16 @@
   :description path

(defun org-docview-complete-link ()
-  "Use the existing file name completion for file: links to get the  
file name,

-   then ask the user for the page number and append it."
+  "Use the existing file name completion for file.
+Links to get the file name, then ask the user for the page number
+and append it."
  (concat (replace-regexp-in-string "^file:" "docview:" (org-file- 
complete-link))

  "::"
  (read-from-minibuffer "Page:" "1")))


(provide 'org-docview)
+
+(provide 'org-docview)
+
+;;; org-docview.el ends here
diff --git a/lisp/org-entities.el b/lisp/org-entities.el
index 59734dc..501eb1c 100644
--- a/lisp/org-entities.el
+++ b/lisp/org-entities.el
@@ -26,6 +26,8 @@
;;
;;; Commentary:

+;;; Code:
+
(require 'org-macs)

(declare-function org-table-align "org-table" ())
@@ -459,7 +461,7 @@ loaded, add these packages to `org-export-latex- 
packages-alist'."
("Diamond" "\\diamond" t "⋄" "[diamond]" "[diamond]"  
"⋄")

("loz" "\\diamond" t "◊" "[lozenge]" "[lozenge]" "◊")
)
-  "Default entities used in Org-mode to preduce special characters.
+  "Default entities used in Org-mode to produce special characters.
For details see `org-entities-user'.")

(defsubst org-entity-get (name)
@@ -521,7 +523,7 @@ Kind can be any of `latex', `html', `ascii',  
`latin1', or `utf8'."

(org-table-align)))

(defun org-entities-help ()
-  "Create a Help buffer with all available entities"
+  "Create a Help buffer with all available entities."
  (interactive)
  (with-output-to-temp-buffer "*Org Entity Help*"
(princ "Org-mode entities\n=\n\n")
@@ -555,7 +557,7 @@ Kind can be any of `latex', `html', `ascii',  
`latin1', or `utf8'."



(defun replace-amp ()
-  "Postprocess HTML file to unescape the ampersant."
+  "Postprocess HTML file to unescape the ampersand."
  (interactive)
  (while (re-search-forward "&\\([^<;]+;\\)" nil t)
(replace-match (concat "&" (match-string 1)) t t)))
diff --git a/lisp/org-exp-blocks.el b/lisp/org-exp-blocks.el
index 4bf5db6..bbe245c 100644
--- a/lisp/org-exp-blocks.el
+++ b/lisp/org-exp-blocks.el
@@ -68,6 +68,8 @@
;; `org-export-blocks-add-block'

[Orgmode] [PATCH] Correct some docstrings [part 2]

[Philip Rooke]

This is a second 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.

Cheers,

Phil

-- 

 lisp/org-docbook.el|8 +++---
 lisp/org-docview.el|   11 ++--
 lisp/org-entities.el   |8 --
 lisp/org-exp-blocks.el |   58 
 lisp/org-exp.el|   29 ++--
 lisp/org-feed.el   |4 +-
 lisp/org-freemind.el   |   14 +-
 lisp/org-habit.el  |3 ++
 lisp/org-html.el   |   56 +
 9 files changed, 106 insertions(+), 85 deletions(-)

diff --git a/lisp/org-docbook.el b/lisp/org-docbook.el
index bbd0bed..c136d20 100644
--- a/lisp/org-docbook.el
+++ b/lisp/org-docbook.el
@@ -26,7 +26,7 @@
 ;; You should have received a copy of the GNU General Public License
 ;; along with GNU Emacs.  If not, see .
 
-;; Commentary:
+;;; Commentary:
 ;;
 ;; This library implements a DocBook exporter for org-mode.  The basic
 ;; idea and design is very similar to what `org-export-as-html' has.
@@ -142,8 +142,8 @@ people work on the same document."
   :type 'string)
 
 (defcustom org-export-docbook-footnote-id-prefix "fn-"
-  "The prefix of footnote IDs used during exporting.  Like
-`org-export-docbook-section-id-prefix', this variable can help
+  "The prefix of footnote IDs used during exporting.
+Like `org-export-docbook-section-id-prefix', this variable can help
 avoid same set of footnote IDs being used multiple times."
   :group 'org-export-docbook
   :type 'string)
@@ -155,7 +155,7 @@ avoid same set of footnote IDs being used multiple times."
 ("=" "" "")
 ("~" "" "")
 ("+" "" ""))
-  "Alist of DocBook expressions to convert emphasis fontifiers.
+  "A list of DocBook expressions to convert emphasis fontifiers.
 Each element of the list is a list of three elements.
 The first element is the character used as a marker for fontification.
 The second element is a formatting string to wrap fontified text with.
diff --git a/lisp/org-docview.el b/lisp/org-docview.el
index 5db6594..b3a5178 100644
--- a/lisp/org-docview.el
+++ b/lisp/org-docview.el
@@ -62,7 +62,7 @@
   )))
 
 (defun org-docview-store-link ()
-  "Store a link to a docview buffer"
+  "Store a link to a docview buffer."
   (when (eq major-mode 'doc-view-mode)
 ;; This buffer is in doc-view-mode
 (let* ((path buffer-file-name)
@@ -75,11 +75,16 @@
:description path
 
 (defun org-docview-complete-link ()
-  "Use the existing file name completion for file: links to get the file name,
-   then ask the user for the page number and append it."
+  "Use the existing file name completion for file.
+Links to get the file name, then ask the user for the page number
+and append it."
   (concat (replace-regexp-in-string "^file:" "docview:" 
(org-file-complete-link))
  "::"
  (read-from-minibuffer "Page:" "1")))
 
 
 (provide 'org-docview)
+
+(provide 'org-docview)
+
+;;; org-docview.el ends here
diff --git a/lisp/org-entities.el b/lisp/org-entities.el
index 59734dc..501eb1c 100644
--- a/lisp/org-entities.el
+++ b/lisp/org-entities.el
@@ -26,6 +26,8 @@
 ;;
 ;;; Commentary:
 
+;;; Code:
+
 (require 'org-macs)
 
 (declare-function org-table-align "org-table" ())
@@ -459,7 +461,7 @@ loaded, add these packages to 
`org-export-latex-packages-alist'."
 ("Diamond" "\\diamond" t "⋄" "[diamond]" "[diamond]" "⋄")
 ("loz" "\\diamond" t "◊" "[lozenge]" "[lozenge]" "◊")
 )
-  "Default entities used in Org-mode to preduce special characters.
+  "Default entities used in Org-mode to produce special characters.
 For details see `org-entities-user'.")
 
 (defsubst org-entity-get (name)
@@ -521,7 +523,7 @@ Kind can be any of `latex', `html', `ascii', `latin1', or 
`utf8'."
 (org-table-align)))
 
 (defun org-entities-help ()
-  "Create a Help buffer with all available entities"
+  "Create a Help buffer with all available entities."
   (interactive)
   (with-output-to-temp-buffer "*Org Entity Help*"
 (princ "Org-mode entities\n=\n\n")
@@ -555,7 +557,7 @@ Kind can be any of `latex', `html', `ascii', `latin1', or 
`utf8'."
 
 
 (defun replace-amp ()
-  "Postprocess HTML file to unescape the ampersant."
+  "Postprocess HTML file to unescape the ampersand."
   (interactive)
   (while (re-search-forward "&\\([^<;]+;\\)" nil t)
 (replace-match (concat "&" (match-string 1)) t t)))
diff --git a/lisp/org-exp-blocks.el b/lisp/org-exp-blocks.el
index 4bf5db6..bbe245c 100644
--- a/lisp/org-exp-blocks.el
+++ b/lisp/org-exp-blocks.el
@@ -68,6 +68,8 @@
 ;; `org-export-blocks-add-block' to add your block type to
 ;; `org-export-blocks'.