emacs-elpa-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[elpa] externals/org f03b839530: lisp/ob-awk.el: Fix docstrings


From: ELPA Syncer
Subject: [elpa] externals/org f03b839530: lisp/ob-awk.el: Fix docstrings
Date: Mon, 31 Jul 2023 09:58:32 -0400 (EDT)

branch: externals/org
commit f03b839530d86269bd23baef2965a316a4172895
Author: Ihor Radchenko <yantar92@posteo.net>
Commit: Ihor Radchenko <yantar92@posteo.net>

    lisp/ob-awk.el: Fix docstrings
    
    * lisp/ob-awk.el (org-babel-execute:awk):
    * lisp/ob-awk.el (org-babel-awk-var-to-awk): Detail all the argument
    in the docstring.
---
 lisp/ob-awk.el | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

diff --git a/lisp/ob-awk.el b/lisp/ob-awk.el
index e5e42a91d1..86af982a67 100644
--- a/lisp/ob-awk.el
+++ b/lisp/ob-awk.el
@@ -53,7 +53,8 @@
   body)
 
 (defun org-babel-execute:awk (body params)
-  "Execute a block of Awk code with org-babel.
+  "Execute a block of Awk code BODY with org-babel.
+PARAMS is a plist of src block parameters .
 This function is called by `org-babel-execute-src-block'."
   (message "Executing Awk source code block")
   (let* ((result-params (cdr (assq :result-params params)))
@@ -100,7 +101,9 @@ This function is called by `org-babel-execute-src-block'."
       (cdr (assq :rowname-names params)) (cdr (assq :rownames params))))))
 
 (defun org-babel-awk-var-to-awk (var &optional sep)
-  "Return a printed value of VAR suitable for parsing with awk."
+  "Return a printed value of VAR suitable for parsing with awk.
+SEP, when non-nil is a separator used when converting list values to awk
+table."
   (let ((echo-var (lambda (v) (if (stringp v) v (format "%S" v)))))
     (cond
      ((and (listp var) (listp (car var)))



reply via email to

[Prev in Thread] Current Thread [Next in Thread]