Browse Source

ob-table.el (org-sbe): Minor enhancements

* ob-table.el (org-sbe): Minor enhancements.
Bastien Guerry 11 years ago
parent
commit
64eea693ae
1 changed files with 13 additions and 9 deletions
  1. 13 9
      lisp/ob-table.el

+ 13 - 9
lisp/ob-table.el

@@ -62,23 +62,27 @@ character and replace it with ellipses."
 
 (defmacro org-sbe (source-block &rest variables)
   "Return the results of calling SOURCE-BLOCK with VARIABLES.
-Each element of VARIABLES should be a two
-element list, whose first element is the name of the variable and
-second element is a string of its value.  The following call to
-`org-sbe' would be equivalent to the following source code block.
+
+Each element of VARIABLES should be a list of two elements: the
+first element is the name of the variable and second element is a
+string of its value.
+
+So this `org-sbe' construct
 
  (org-sbe 'source-block (n $2) (m 3))
 
-#+begin_src emacs-lisp :var results=source-block(n=val_at_col_2, m=3) :results silent
-results
-#+end_src
+is the equivalent of the following source code block:
+
+ #+begin_src emacs-lisp :var results=source-block(n=val_at_col_2, m=3) :results silent
+ results
+ #+end_src
 
-NOTE: by default string variable names are interpreted as
+NOTE: By default, string variable names are interpreted as
 references to source-code blocks, to force interpretation of a
 cell's value as a string, prefix the identifier a \"$\" (e.g.,
 \"$$2\" instead of \"$2\" or \"$@2$2\" instead of \"@2$2\").
 
-NOTE: it is also possible to pass header arguments to the code
+NOTE: It is also possible to pass header arguments to the code
 block.  In this case a table cell should hold the string value of
 the header argument which can then be passed before all variables
 as shown in the example below.