emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Aaron Ecay <aaronecay@gmail.com>
To: "Charles C. Berry" <ccberry@ucsd.edu>,
	Nicolas Goaziou <mail@nicolasgoaziou.fr>
Cc: mcg <giepen.m@googlemail.com>,
	Andreas Leha <andreas.leha@med.uni-goettingen.de>,
	emacs-orgmode@gnu.org, Ista Zahn <istazahn@gmail.com>
Subject: Re: New patches WAS Re: [PATCH] inline src block results can be removed
Date: Fri, 16 Jan 2015 22:22:03 -0500	[thread overview]
Message-ID: <874mrqjdlw.fsf@gmail.com> (raw)
In-Reply-To: <alpine.OSX.2.00.1501121608520.1829@charlessmacbook>

Hi Chuck,

Thanks for the patches.

I agree with Nicolas about the issue of multi-line results for inline
blocks.  I think he already raised any comments I would have made about
the code.  Additional comments about broader issues:

2015ko urtarrilak 12an, "Charles C. Berry"-ek idatzi zuen:
>  (defun org-babel-insert-result
>    (result &optional result-params info hash indent lang)
>    "Insert RESULT into the current buffer.

It’s not strictly speaking relevant to your patch, but it would be good to
put a couple sentences about the :wrap header arg in this docstring.  I
think it could go at the end, and read something like “Specifying a :wrap
header argument will wrap the result in a #+begin_/#+end_ block or (for
inline source blocks) an export snippet whose type is determined by the
value of the argument (with a default of "results").  The specification of
:wrap overrides the :result values described above.”

[...]

>  drawer -- results are added directly to the Org-mode file as with
> -          \"raw\", but are wrapped in a RESULTS drawer, allowing
> -          them to later be replaced or removed automatically.
> +          \"raw\", but are wrapped in a RESULTS drawer or results
> +          macro, allowing them to later be replaced or removed
> +          automatically.
>

I think it’s worth changing the name of this option, now that it no
longer creates a drawer in all cases.  Perhaps raw-wrap could be used.
(Of course, drawer would be retained as a backwards compatibility alias,
preferably with a comment in the code describing when and why it was
deprecated.)  This would also require changes to the manual.

[...]

>  		    (funcall wrap (concat "#+BEGIN_" name)
> -			     (concat "#+END_" (car (org-split-string name))))))
> +			     (concat "#+END_" (car (org-split-string name)))
> +			     nil nil (concat "{{{results(@@" name ":") "@@)}}}")))

I think it would be more flexible to allow :wrap to change the name of
the macro which is used, rather than to insert an export snippet.  If a
custom export snippet is desired, this could be specified via the custom
macro name – but the macro could also supply other special formatting.
(This suggestion would impact the wording of the docstring addition
suggested above.)  WDYT?

Especially the first two of these suggestions are things I (or anyone)
could implement in further patches, if you’d rather not take them on at
present.

Thanks,
 
-- 
Aaron Ecay

  parent reply	other threads:[~2015-01-17  3:22 UTC|newest]

Thread overview: 32+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-11-12  0:49 [PATCH] inline src block results can be removed Charles C. Berry
2014-11-12  1:10 ` Andreas Leha
2014-11-12  6:58   ` Charles C. Berry
2014-11-12 19:34 ` Aaron Ecay
2014-11-12 23:47   ` Charles C. Berry
2014-11-13 17:48     ` Nicolas Goaziou
2014-11-13 19:06       ` Andreas Leha
2014-11-14 17:43       ` Charles C. Berry
2014-11-14 20:39         ` Nicolas Goaziou
2014-11-14 23:04           ` Aaron Ecay
2014-11-16  0:10             ` Nicolas Goaziou
2014-11-15 20:22           ` Charles C. Berry
2014-11-16 23:23             ` Nicolas Goaziou
2014-11-24  9:48               ` Daniele Pizzolli
2014-11-24 10:18                 ` Andreas Leha
2015-01-13  0:48               ` New patches WAS " Charles C. Berry
2015-01-16 22:41                 ` Nicolas Goaziou
2015-01-19  3:22                   ` Charles C. Berry
2015-01-19 17:53                     ` Nicolas Goaziou
2015-01-19 19:31                       ` Charles C. Berry
2015-01-20 23:30                         ` Nicolas Goaziou
2015-01-22  3:07                           ` Charles C. Berry
2015-01-22 23:08                             ` Nicolas Goaziou
2015-01-24 22:47                               ` Charles C. Berry
2015-01-25  1:14                                 ` Aaron Ecay
2015-01-25  5:01                                   ` Charles C. Berry
2015-01-29 20:31                               ` Charles C. Berry
2015-01-17  3:22                 ` Aaron Ecay [this message]
2015-01-17 22:20                   ` Nicolas Goaziou
2015-01-18 19:13                     ` Aaron Ecay
2015-01-18 22:34                       ` Nicolas Goaziou
2015-01-18 22:55                         ` Aaron Ecay

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.orgmode.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=874mrqjdlw.fsf@gmail.com \
    --to=aaronecay@gmail.com \
    --cc=andreas.leha@med.uni-goettingen.de \
    --cc=ccberry@ucsd.edu \
    --cc=emacs-orgmode@gnu.org \
    --cc=giepen.m@googlemail.com \
    --cc=istazahn@gmail.com \
    --cc=mail@nicolasgoaziou.fr \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).