summaryrefslogtreecommitdiff
path: root/lisp/ob-latex.el
diff options
context:
space:
mode:
authorIhor Radchenko <yantar92@posteo.net>2023-09-19 15:49:09 +0300
committerIhor Radchenko <yantar92@posteo.net>2023-09-19 15:49:09 +0300
commite42b7a6fddbd485af735b54902bbb1724acdd6f5 (patch)
tree44927c3dd43269046dc8885fe4cafc3c3e2de5de /lisp/ob-latex.el
parent6c917e8904802379bf2db1e5b407067239b4495c (diff)
* lisp/ob-latex.el: Document all the function arguments
(org-babel-execute:latex): (org-babel-latex-convert-pdf):
Diffstat (limited to 'lisp/ob-latex.el')
-rw-r--r--lisp/ob-latex.el6
1 files changed, 4 insertions, 2 deletions
diff --git a/lisp/ob-latex.el b/lisp/ob-latex.el
index ce39628d6..4b216317e 100644
--- a/lisp/ob-latex.el
+++ b/lisp/ob-latex.el
@@ -141,7 +141,7 @@ exporting the literal LaTeX source."
(org-trim body))
(defun org-babel-execute:latex (body params)
- "Execute a block of LaTeX code with Babel.
+ "Execute LaTeX BODY according to PARAMS.
This function is called by `org-babel-execute-src-block'."
(setq body (org-babel-expand-body:latex body params))
(if (cdr (assq :file params))
@@ -273,7 +273,9 @@ This function is called by `org-babel-execute-src-block'."
body))
(defun org-babel-latex-convert-pdf (pdffile out-file im-in-options im-out-options)
- "Generate a file from a pdf file using imagemagick."
+ "Generate OUT-FILE from PDFFILE using imagemagick.
+IM-IN-OPTIONS are command line options for input file, as a string;
+and IM-OUT-OPTIONS are the output file options."
(let ((cmd (concat "convert " im-in-options " " pdffile " "
im-out-options " " out-file)))
(message "Converting pdffile file %s..." cmd)