Re: [O] [PATCH] Change to org-src-preserve-indentation documentation

[Nicolas Goaziou]

Hello,

John Hendy <address@hidden> writes:

> Per some other discussions on the mentioned variable, I added a bit
> more information to org.texi to help other users find it's
> documentation in the manual.

Thank you for the patch. It is certainly better than what we have
actually.

Some comments follow.

> -This variable is especially useful for tangling languages such as
> +By default, the value is @code{nil}, which means that whitespace characters 
> will be
> +collapsed upon exporting/tangling, according to the value of

I think "exporting or tangling" is better than "exporting/tangling", but
I'm no native speaker.

Also, I'm not sure if "collapsed" is very clear. During export, when the
source block is evaluated, it is removed from the buffer and, maybe,
inserted back. At this point, if `org-src-preserve-indentation' is nil,
every line is indented back to the same column as it was before.  Tabs
can appear in the process.

If `org-src-preserve-indentation' is nil, global indentation is lost,
but the local one is preserved. Since no indentation happens, tabs
cannot appear in the process.

> address@hidden If set to @code{t}, code

In Texinfo, sentences have to end with two spaces. Also, the variable
doesn't need to be set to the symbol t, as any value but nil will
achieve the same result. So the sentence could start with something
like :

  When non-nil, code blocks...

> +blocks will be exported/tangled with whitespace preserved, exactly as they

exported or tangled, maybe

> +appear in the org buffer. This variable is especially useful for
> tangling languages such as

It should be Org, not org. And two spaces are required.


Regards,  

-- 
Nicolas Goaziou