From: "Nícolas F. R. A. Prado" <nfraprado@collabora.com>
To: Thorsten Leemhuis <regressions@leemhuis.info>
Cc: Jonathan Corbet <corbet@lwn.net>,
kernel@collabora.com, regressions@lists.linux.dev,
linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
workflows@vger.kernel.org
Subject: Re: [PATCH 1/2] docs: *-regressions.rst: Use collon after regzbot introduced command
Date: Mon, 11 Mar 2024 09:57:56 -0400 [thread overview]
Message-ID: <2d666b8c-96c7-4789-8282-6b28cd932920@notapiano> (raw)
In-Reply-To: <82cf3fba-fdfa-4185-b2b9-c8ed8d123136@leemhuis.info>
On Mon, Mar 11, 2024 at 02:39:46PM +0100, Thorsten Leemhuis wrote:
> Thx for this!
>
> On 08.03.24 15:09, Nícolas F. R. A. Prado wrote:
> > All the examples in the reference documentation for regzbot have a
> > collon
>
> s/collon/colon/ here and a few lines below as well. And in the subject
> as well. Speaking of which: something like "docs: *-regressions.rst:
> add colon to regzbot commands" might be better.
>
> > after the "introduced" command, while on the kernel documentation
> > some have and others don't. This suggests both are acceptable,
>
> Yup.
>
> > but in
> > order to avoid confusion, add collons after all the commands to match
> > the reference docs.
>
> Yeah, good idea. I likely would have done this myself soon while doing a
> few other changes I plan, but whatever. :-D
>
> > Link: https://gitlab.com/knurd42/regzbot/-/blob/main/docs/reference.md
> > Signed-off-by: Nícolas F. R. A. Prado <nfraprado@collabora.com>
>
> With the changes above:
>
> Reviewed-by: Thorsten Leemhuis <linux@leemhuis.info>
>
> Side note: I wonder if the commit message could come a bit quicker to
> the point (something along the lines of "Use colons as command
> terminator everywhere for consistency, even if it not strictly
> necessary. That way it will also match regzbot's reference
> documentation.". But not really important I guess. Up to John.
Yep, all great suggestions, thanks. Will apply them for v2.
Thanks,
Nícolas
next prev parent reply other threads:[~2024-03-11 13:58 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-03-08 14:09 [PATCH 0/2] docs: *-regressions.rst: Tweaks to the commands Nícolas F. R. A. Prado
2024-03-08 14:09 ` [PATCH 1/2] docs: *-regressions.rst: Use collon after regzbot introduced command Nícolas F. R. A. Prado
2024-03-11 13:39 ` Thorsten Leemhuis
2024-03-11 13:57 ` Nícolas F. R. A. Prado [this message]
2024-03-08 14:10 ` [PATCH 2/2] docs: handling-regressions.rst: Update regzbot command fixed-by to fix Nícolas F. R. A. Prado
2024-03-11 13:40 ` Thorsten Leemhuis
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=2d666b8c-96c7-4789-8282-6b28cd932920@notapiano \
--to=nfraprado@collabora.com \
--cc=corbet@lwn.net \
--cc=kernel@collabora.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=regressions@leemhuis.info \
--cc=regressions@lists.linux.dev \
--cc=workflows@vger.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;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).