From: Jonathan Corbet <corbet@lwn.net>
To: Alexey Brodkin <Alexey.Brodkin@synopsys.com>, linux-doc@vger.kernel.org
Cc: linux-snps-arc@lists.infradead.org,
Alexey Brodkin <Alexey.Brodkin@synopsys.com>,
Randy Dunlap <rdunlap@infradead.org>,
Vineet Gupta <vgupta@kernel.org>
Subject: Re: [PATCH] docs: ARC: Improve readability
Date: Fri, 10 Dec 2021 14:28:12 -0700 [thread overview]
Message-ID: <87ee6kqheb.fsf@meer.lwn.net> (raw)
In-Reply-To: <20211202215747.19923-1-abrodkin@synopsys.com>
Alexey Brodkin <Alexey.Brodkin@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@synopsys.com>
> Cc: Randy Dunlap <rdunlap@infradead.org>
> Cc: Jonathan Corbet <corbet@lwn.net>
> Cc: Vineet Gupta <vgupta@kernel.org>
> ---
> Documentation/arc/arc.rst | 62 +++++++++++++++++++++------------------
> 1 file changed, 33 insertions(+), 29 deletions(-)
Applied, thanks.
jon
_______________________________________________
linux-snps-arc mailing list
linux-snps-arc@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-snps-arc
prev parent reply other threads:[~2021-12-10 21:28 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-12-02 21:57 [PATCH] docs: ARC: Improve readability Alexey Brodkin
2021-12-10 21:28 ` Jonathan Corbet [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87ee6kqheb.fsf@meer.lwn.net \
--to=corbet@lwn.net \
--cc=Alexey.Brodkin@synopsys.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-snps-arc@lists.infradead.org \
--cc=rdunlap@infradead.org \
--cc=vgupta@kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox