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

Re: [libvirt] [PATCH v3 08/13] docs: process code blocks similar to markdown



On 01/30/2013 08:38 AM, Claudio Bley wrote:
> Wrap pre-formatted example code in <pre> elements. This works
> similar to markdown code blocks.
> 
> Every line indented with at least 2 spaces is considered a code
> block and gets wrapped in a <pre> tag.

Please, put a reference to an affected API in the commit message itself.
 I shouldn't have to hunt back to your v2 posting to see that you
mentioned #virStreamRecv as a working sample.

> 
> Signed-off-by: Claudio Bley <cbley av-test de>
> ---
>  docs/newapi.xsl |   89 +++++++++++++++++++++++++++++++++++++++++--------------
>  1 file changed, 67 insertions(+), 22 deletions(-)

This ate the 'do' part of the 'done:' label line in the code; if you fix
that later in the series, you should rearrange the patches to get that
fixed first.  What prevents us from silently chopping off other leading
information on code samples?  Can you turn it into an error and/or end
the <code> markup on any line that does not have the two leading spaces?

I do like the result, though, once we tweak the remaining issues.

-- 
Eric Blake   eblake redhat com    +1-919-301-3266
Libvirt virtualization library http://libvirt.org

Attachment: signature.asc
Description: OpenPGP digital signature


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