summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNicolas Goaziou <n.goaziou@gmail.com>2013-04-17 20:44:28 (GMT)
committer Nicolas Goaziou <n.goaziou@gmail.com>2013-04-17 20:45:07 (GMT)
commit58f7e4382101b555fe7d6af460bfa2fb6208adb5 (patch)
treeb74d657dfa5c4d09f308120b7c6dccb3e7be51a3
parentbdde7db20cf5e267e10a97f7e8daccc056b9556b (diff)
downloadorg-mode-58f7e4382101b555fe7d6af460bfa2fb6208adb5.zip
org-mode-58f7e4382101b555fe7d6af460bfa2fb6208adb5.tar.gz
ox-org.el: Fix some docstrings
* lisp/ox-org.el (org-org-identity): Fix docstring. Tiny refactoring. (org-org-headline, org-org-keyword): Fix docstring.
-rw-r--r--lisp/ox-org.el13
1 files changed, 7 insertions, 6 deletions
diff --git a/lisp/ox-org.el b/lisp/ox-org.el
index 18925c5..f55b5dc 100644
--- a/lisp/ox-org.el
+++ b/lisp/ox-org.el
@@ -117,13 +117,13 @@ setting of `org-html-htmlize-output-type' is 'css."
(org-open-file (org-org-export-to-org nil s v b))))))))
(defun org-org-identity (blob contents info)
- "Transcode BLOB element or object back into Org syntax."
- (funcall
- (intern (format "org-element-%s-interpreter" (org-element-type blob)))
- blob contents))
+ "Transcode BLOB element or object back into Org syntax.
+CONTENTS is its contents, as a string or nil. INFO is ignored."
+ (org-export-expand blob contents))
(defun org-org-headline (headline contents info)
- "Transcode HEADLINE element back into Org syntax."
+ "Transcode HEADLINE element back into Org syntax.
+CONTENTS is its contents, as a string or nil. INFO is ignored."
(unless (plist-get info :with-todo-keywords)
(org-element-put-property headline :todo-keyword nil))
(unless (plist-get info :with-tags)
@@ -134,7 +134,8 @@ setting of `org-html-htmlize-output-type' is 'css."
(defun org-org-keyword (keyword contents info)
"Transcode KEYWORD element back into Org syntax.
-Ignore keywords targeted at other export back-ends."
+CONTENTS is nil. INFO is ignored. This function ignores
+keywords targeted at other export back-ends."
(unless (member (org-element-property :key keyword)
(mapcar
(lambda (block-cons)