From mboxrd@z Thu Jan 1 00:00:00 1970 From: John Hendy Subject: Re: [PATCH] Update documentation for :exports (applicable to blocks only, not inline) Date: Fri, 14 Mar 2014 11:06:49 -0500 Message-ID: References: <87y50fwidf.fsf@bzg.ath.cx> <87eh26ms19.fsf@bzg.ath.cx> <87txb0pymm.fsf@bzg.ath.cx> Mime-Version: 1.0 Content-Type: multipart/mixed; boundary=001a1133d79ce1939d04f4934113 Return-path: Received: from eggs.gnu.org ([2001:4830:134:3::10]:40547) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1WOUdH-0002rn-ND for emacs-orgmode@gnu.org; Fri, 14 Mar 2014 12:06:52 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1WOUdG-00052p-Bd for emacs-orgmode@gnu.org; Fri, 14 Mar 2014 12:06:51 -0400 Received: from mail-yk0-x22a.google.com ([2607:f8b0:4002:c07::22a]:53438) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1WOUdG-00052V-6m for emacs-orgmode@gnu.org; Fri, 14 Mar 2014 12:06:50 -0400 Received: by mail-yk0-f170.google.com with SMTP id 9so7201607ykp.1 for ; Fri, 14 Mar 2014 09:06:49 -0700 (PDT) In-Reply-To: <87txb0pymm.fsf@bzg.ath.cx> List-Id: "General discussions about Org-mode." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org Sender: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org To: Bastien Cc: emacs-orgmode --001a1133d79ce1939d04f4934113 Content-Type: text/plain; charset=UTF-8 On Fri, Mar 14, 2014 at 10:51 AM, Bastien wrote: > Hi John, > > thanks for the patch -- some comments below. > > John Hendy 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 --001a1133d79ce1939d04f4934113 Content-Type: text/x-patch; charset=US-ASCII; name="0001-clarified-documentation-for-exports-only-applicable-.patch" Content-Disposition: attachment; filename="0001-clarified-documentation-for-exports-only-applicable-.patch" Content-Transfer-Encoding: base64 X-Attachment-Id: f_hsrnri2k0 SGVhZGVyIGFyZ3VtZW50czogY2xhcmlmeSBpbiBkb2Mvb3JnLnRleGkgdGhhdCBgOmV4cG9ydHMn IGlzIG9ubHkgYXBwbGljYWJsZSB0bwpibG9ja3MsIG5vdCBpbmxpbmUgY29kZQoKKiBkb2Mvb3Jn LnRleGkgKEV4cG9ydGluZyBjb2RlIGJsb2NrcywgZXhwb3J0cyk6IENsYXJpZnkuCgpUaGUgZG9j dW1lbnRhdGlvbiBjaGFuZ2UgcmVzdWx0ZWQgZnJvbSB0aGUgZXhwZWN0YXRpb24gdGhhdCBgOmV4 cG9ydHMnCmNvdWxkIGJlIHVzZWQgd2l0aCBpbmxpbmUgY29kZSBibG9ja3MsIHdoaWNoIGlzIG5v dCB0aGUgY2FzZS4KQ2xhcmlmaWNhdGlvbiB3YXMgYWRkZWQgdG8gYXZvaWQgZnV0dXJlIGNvbmZ1 c2lvbiBvbiB0aGlzIGhlYWRlcgphcmd1bWVudCwgd2hpY2ggaXMgYXBwbGljYWJsZSBvbmx5IHRv IGJsb2Nrcy4KClRJTllDSEFOR0UKCkZyb20gZDkyYzMwMTE2NjAyYTk3ZjJiMTE2ODRjZjVjNjZk ZTM5NzJkMTQ3YiBNb24gU2VwIDE3IDAwOjAwOjAwIDIwMDEKRnJvbTogSm9obiBIZW5kZXJzb24g PGp3LmhlbmR5QGdtYWlsLmNvbT4KRGF0ZTogRnJpLCAxNCBNYXIgMjAxNCAxMDoyOTozMyAtMDUw MApTdWJqZWN0OiBbUEFUQ0hdIGNsYXJpZmllZCBkb2N1bWVudGF0aW9uIGZvciA6ZXhwb3J0czsg b25seSBhcHBsaWNhYmxlIHRvCiBibG9ja3MsIG5vdCBpbmxpbmUgY29kZQoKLS0tCiBkb2Mvb3Jn LnRleGkgfCA2ICsrKystLQogMSBmaWxlIGNoYW5nZWQsIDQgaW5zZXJ0aW9ucygrKSwgMiBkZWxl dGlvbnMoLSkKCmRpZmYgLS1naXQgYS9kb2Mvb3JnLnRleGkgYi9kb2Mvb3JnLnRleGkKaW5kZXgg OTNkNWZkMi4uMDRiZTAwOSAxMDA2NDQKLS0tIGEvZG9jL29yZy50ZXhpCisrKyBiL2RvYy9vcmcu dGV4aQpAQCAtMTM4MjgsNyArMTM4MjgsOCBAQCByZXN1bHRzIG9mIGNvZGUgYmxvY2sgZXZhbHVh dGlvbi4gIEZvciBpbmZvcm1hdGlvbiBvbiBleHBvcnRpbmcgY29kZSBibG9jawogYm9kaWVzLCBz ZWUgQHJlZntMaXRlcmFsIGV4YW1wbGVzfS4KIAogVGhlIEBjb2RlezpleHBvcnRzfSBoZWFkZXIg YXJndW1lbnQgY2FuIGJlIHVzZWQgdG8gc3BlY2lmeSBleHBvcnQKLWJlaGF2aW9yOgorYmVoYXZp b3IgKG5vdGUgdGhhdCB0aGVzZSBhcmd1bWVudHMgYXJlIG9ubHkgcmVsZXZhbnQgZm9yIGNvZGUg YmxvY2tzLCBub3QKK2lubGluZSBjb2RlKToKIAogQHN1YnN1YmhlYWRpbmcgSGVhZGVyIGFyZ3Vt ZW50czoKIApAQCAtMTQ4MzEsNyArMTQ4MzIsOCBAQCB3aGljaCB0aGUgbGluayBkb2VzIG5vdCBw b2ludC4KIEBjaW5kZXggQGNvZGV7OmV4cG9ydHN9LCBzcmMgaGVhZGVyIGFyZ3VtZW50CiAKIFRo ZSBAY29kZXs6ZXhwb3J0c30gaGVhZGVyIGFyZ3VtZW50IHNwZWNpZmllcyB3aGF0IHNob3VsZCBi ZSBpbmNsdWRlZCBpbiBIVE1MCi1vciBATGFUZVh7fSBleHBvcnRzIG9mIHRoZSBPcmcgbW9kZSBm aWxlLgorb3IgQExhVGVYe30gZXhwb3J0cyBvZiB0aGUgT3JnIG1vZGUgZmlsZS4gTm90ZSB0aGF0 IHRoZSBAY29kZXs6ZXhwb3J0c30KK29wdGlvbiBpcyBvbmx5IHJlbGV2YW50IGZvciBjb2RlIGJs b2Nrcywgbm90IGlubGluZSBjb2RlLgogCiBAaXRlbWl6ZSBAYnVsbGV0CiBAaXRlbSBAY29kZXtj b2RlfQotLSAKMS45LjAKCg== --001a1133d79ce1939d04f4934113--