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

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

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

On Fri, Mar 14, 2014 at 10:51 AM, Bastien <bzg@altern.org> wrote:
> Hi John,
>
> thanks for the patch -- some comments below.
>
> John Hendy <jw.hendy@gmail.com> writes:
>
>> Header arguments: clarify that `:exports' is only applicable to
>> blocks, not inline code
>
> This first line should include "org.texi:" to tell that the change
> happens in org.texi.  See other commits for examples.
>

Gotcha. That wasn't in the manual example for the first line. I've
added it to my re-attempt attached.

>> * doc/org.texi (Exporting code blocks): add clarification; relevant for blocks ony.
>
> Start with a capitalized letter: "Add clarification."
> Don't use semi-column.  "Clarify" is enough IMO.
>

Even after reading the instructions, I *still* missed the capitalization bit...

>> * doc/org.texi (exports): add clarification; relevant for blocks only.
>
> When two changes get the same description use this:
>
> * doc/org.texi (Exporting code blocks, exports): Clarify.
>

Awesome. I wondered about that as well.

> In general, you can make it easier for you by reviewing the patch (hit
> `C-x v =' in the modified org.texi buffer), and then hit `C-x 4 a' on
> each change to create a Changelog buffer that you can safely edit.
>

Thanks for the tips.

>> 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.
>
> Please use auto-fill and fill-column to something between 72 and 80.
>

Done.

>> TINYCHANGE
>
> Thanks again for the patch, HTH,
>

No problem.


John

> --
>  Bastien

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

Header arguments: clarify in doc/org.texi that `:exports' is only applicable to
blocks, not inline code

* doc/org.texi (Exporting code blocks, exports): Clarify.

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 header
argument, which is applicable only to blocks.

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