emacs-orgmode
[Top][All Lists]
Advanced

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

Re: [O] [PATCH] Update documentation for :exports (applicable to blocks


From: Bastien
Subject: Re: [O] [PATCH] Update documentation for :exports (applicable to blocks only, not inline)
Date: Fri, 14 Mar 2014 16:51:13 +0100
User-agent: Gnus/5.13 (Gnus v5.13) Emacs/24.3.50 (gnu/linux)

Hi John,

thanks for the patch -- some comments below.

John Hendy <address@hidden> 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.

> * 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.

> * 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.

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.
        
> 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.

> TINYCHANGE

Thanks again for the patch, HTH,

-- 
 Bastien



reply via email to

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