emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed

From: Bastien <bzg@altern.org>
To: John Hendy <jw.hendy@gmail.com>
Cc: emacs-orgmode <emacs-orgmode@gnu.org>
Subject: Re: [PATCH] Update documentation for :exports (applicable to blocks only, not inline)
Date: Fri, 14 Mar 2014 16:51:13 +0100	[thread overview]
Message-ID: <87txb0pymm.fsf@bzg.ath.cx> (raw)
In-Reply-To: <CA+M2ft_jVn8hOBPqR9cFc0qU1++7qiaR=w5UY9-X-nfWF9j4fA@mail.gmail.com>	(John Hendy's message of "Fri, 14 Mar 2014 10:44:57 -0500")

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.

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

next prev parent reply	other threads:[~2014-03-14 15:51 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-03-12  1:38 [PATCH] Update documentation for :exports (applicable to blocks only, not inline) John Hendy
2014-03-12 15:23 ` Bastien
2014-03-13  2:08   ` John Hendy
2014-03-13  8:17     ` Bastien
2014-03-14 15:44       ` John Hendy
2014-03-14 15:51         ` Bastien [this message]
2014-03-14 16:06           ` John Hendy
2014-03-14 16:17             ` Bastien
2014-03-14 16:25               ` John Hendy

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=87txb0pymm.fsf@bzg.ath.cx \
    --to=bzg@altern.org \
    --cc=emacs-orgmode@gnu.org \
    --cc=jw.hendy@gmail.com \
    /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

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