Re: [PATCH] Update documentation for :exports (applicable to blocks only, not inline)

[John Hendy <jw.hendy@gmail.com>]

[-- Attachment #1: Type: text/plain, Size: 822 bytes --]

On Thu, Mar 13, 2014 at 3:17 AM, Bastien <bzg@gnu.org> wrote:
> Hi John,
>
> John Hendy <jw.hendy@gmail.com> writes:
>
>> The trailing whitespace is the result of my texi ignorance. In a
>> previous patch, Nicolas clarified that sentences needed to end in two
>> spaces, and I add them at the end of my last sentence thinking they
>> might be required to identify a new next bit. Understanding now that
>> an endline/carriage return is sufficient and the spaces are not
>> needed.
>
> Yes, two spaces are only needed to separate sentences on the same
> line.
>
> Thanks in advance for rewriting the patch, I know it can be tiresome.

No problem. Is the attached satisfactory? I worked along with the
ChangeLog documentation, but will start a new thread as I don't think
it's *that* clear :)

Thanks,
John

> --
>  Bastien

[-- Attachment #2: 0001-clarified-documentation-for-exports-only-applicable-.patch --]
[-- Type: text/x-patch, Size: 1679 bytes --]

Header arguments: clarify that `:exports' is only applicable to blocks, not inline code

* doc/org.texi (Exporting code blocks): add clarification; relevant for blocks ony.

* doc/org.texi (exports): add clarification; relevant for blocks only.

The documentation change resulted from the expectation that `:exports' could be used with inline code blocks, which is not the case. Clarification was added to avoid future confusion on this Babel block specific header argument.

TINYCHANGE

From d92c30116602a97f2b11684cf5c66de3972d147b Mon Sep 17 00:00:00 2001
From: John Henderson <jw.hendy@gmail.com>
Date: Fri, 14 Mar 2014 10:29:33 -0500
Subject: [PATCH] clarified documentation for :exports; only applicable to
 blocks, not inline code

---
 doc/org.texi | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/doc/org.texi b/doc/org.texi
index 93d5fd2..04be009 100644
--- a/doc/org.texi
+++ b/doc/org.texi
@@ -13828,7 +13828,8 @@ results of code block evaluation.  For information on exporting code block
 bodies, see @ref{Literal examples}.
 
 The @code{:exports} header argument can be used to specify export
-behavior:
+behavior (note that these arguments are only relevant for code blocks, not
+inline code):
 
 @subsubheading Header arguments:
 
@@ -14831,7 +14832,8 @@ which the link does not point.
 @cindex @code{:exports}, src header argument
 
 The @code{:exports} header argument specifies what should be included in HTML
-or @LaTeX{} exports of the Org mode file.
+or @LaTeX{} exports of the Org mode file. Note that the @code{:exports}
+option is only relevant for code blocks, not inline code.
 
 @itemize @bullet
 @item @code{code}
-- 
1.9.0