[PATCH] docs: ARC: Improve readability

Jonathan Corbet corbet at lwn.net
Fri Dec 10 13:28:12 PST 2021


Alexey Brodkin <Alexey.Brodkin at synopsys.com> writes:

> There were some things which made rendered document
> look not very elegant. That was because:
>
> 1. Numbered lists were formatted in more of Markdown way
>    rather than true reStructuredText and so were displayed
>    as a plain text with leading numbers.
>
>    Well, moreover numbered lists were not needed as in all cases
>    we were just listing a couple of options w/o any intention to
>    follow any particular order, so a simpler unordered list fits
>    better and looks cleaner.
>
> 2. URL's of external resources were added as they are
>    (which is OK in a plain text, but make not much sense in
>    a HTML where we may use more human-friendly link names
>    with URL's hidden.
>
> 3. Some URL's had trailing slashes which were not really needed
>
> Fix all items from above!
>
> Signed-off-by: Alexey Brodkin <abrodkin at synopsys.com>
> Cc: Randy Dunlap <rdunlap at infradead.org>
> Cc: Jonathan Corbet <corbet at lwn.net>
> Cc: Vineet Gupta <vgupta at kernel.org>
> ---
>  Documentation/arc/arc.rst | 62 +++++++++++++++++++++------------------
>  1 file changed, 33 insertions(+), 29 deletions(-)

Applied, thanks.

jon



More information about the linux-snps-arc mailing list