[Top][All Lists]

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

Re: [PATCH 1/4] doc: fix copy-pasted examples of regexp

From: Alexandre Jasmin
Subject: Re: [PATCH 1/4] doc: fix copy-pasted examples of regexp
Date: Thu, 9 Feb 2017 17:08:50 -0500

>> [PATCH 2/4] doc: rework BRE/ERE table to fit PDF manual
> Will need a bit more review, hope to have this soon.

It can definitely use more work. But the current formatting doesn't
quite work either.

While "@exampleindent 0" works in the pdf, there's still a margin in
the info output. I don't know about splitting the command in two
either. Perhaps leave out the sed invocation and show the regex alone
to save horizontal space.

>> [PATCH 4/4] doc: reference the i command in /regexp/I
> Here I would suggest not using @ref as an embedded word.
> texinfo renders it nicely in HTML (making it an <a> tag),
> but in PDF it will look strange:
> "However, in sed the i is used for the (see [insert command], page 13)."
> Attached is a slight modification to your patch, comments welcomed.

The rendering looks good but your patch has a typo: "insert comment"

> However if you plan to send more patches (which we very much encourage!),
> please fill out the copyright assignment form:

Done. Hope to contribute more as time permits.

Something else I'd like to fix is the inconsistent use of
@codequoteundirected and @codequotebacktick in the documentation.

In the PDF you often see both styles on the same page. Can't we just
set that once and forget it?

reply via email to

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