summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNicolas Goaziou <mail@nicolasgoaziou.fr>2016-12-14 21:37:03 +0100
committerNicolas Goaziou <mail@nicolasgoaziou.fr>2016-12-14 21:37:03 +0100
commit22a4896bf87b2d7a61062f25908a02b9f269e014 (patch)
tree2a616c11754f176ce71481653001fc21cbd284e7
parentb5cebbc41294dbded9c9ad9d8f50ca0419e6d6a7 (diff)
downloadorg-mode-22a4896bf87b2d7a61062f25908a02b9f269e014.tar.gz
org-info: Fix docstrings
* lisp/org-info.el (org-info-other-documents): (org-info-map-html-url): Fix docstrings. Suggested-by: Chunyang Xu <mail@xuchunyang.me>
-rw-r--r--lisp/org-info.el26
1 files changed, 13 insertions, 13 deletions
diff --git a/lisp/org-info.el b/lisp/org-info.el
index d82168e..b6e8e09 100644
--- a/lisp/org-info.el
+++ b/lisp/org-info.el
@@ -97,21 +97,21 @@ Taken from <http://www.gnu.org/software/emacs/manual/html_mono/.>")
(defconst org-info-other-documents
'(("libc" . "http://www.gnu.org/software/libc/manual/html_mono/libc.html")
("make" . "http://www.gnu.org/software/make/manual/make.html"))
- "Alist of documents generated from texinfo source.
-
-When converting info links to html, links to any one of these manuals are
-converted to use these URL's.")
+ "Alist of documents generated from Texinfo source.
+When converting info links to HTML, links to any one of these manuals are
+converted to use these URL.")
(defun org-info-map-html-url (filename)
- "Given info FILENAME, either return it (plus '.html' suffix added) or convert
-it to URL pointing to the official page on internet, e.g., use gnu.org for all
-emacs related documents. See `org-info-official-gnu-document' and
-`org-info-other-documents' for details."
- (if (member filename org-info-emacs-documents)
- (format "http://www.gnu.org/software/emacs/manual/html_mono/%s.html"
- filename)
- (let ((url (cdr (assoc filename org-info-other-documents))))
- (or url (concat filename ".html")))))
+ "Return URL or HTML file associated to Info FILENAME.
+If FILENAME refers to an official GNU document, return a URL pointing to
+the official page for that document, e.g., use \"gnu.org\" for all Emacs
+related documents. Otherwise, append \".html\" extension to FILENAME.
+See `org-info-emacs-documents' and `org-info-other-documents' for details."
+ (cond ((member filename org-info-emacs-documents)
+ (format "http://www.gnu.org/software/emacs/manual/html_mono/%s.html"
+ filename))
+ ((cdr (assoc filename org-info-other-documents)))
+ (t (concat filename ".html"))))
(defun org-info-export (path desc format)
"Export an info link.