qemu-devel.nongnu.org archive mirror
 help / color / mirror / Atom feed
From: "Daniel P. Berrangé" <berrange@redhat.com>
To: Markus Armbruster <armbru@redhat.com>
Cc: qemu-devel@nongnu.org, eblake@redhat.com, michael.roth@amd.com,
	kkostiuk@redhat.com, jsnow@redhat.com
Subject: Re: [PATCH 3/4] qga: Rephrase return docs to avoid type name
Date: Thu, 17 Jul 2025 09:29:59 +0100	[thread overview]
Message-ID: <aHi0hx-z6sgHSFwR@redhat.com> (raw)
In-Reply-To: <20250717082117.3767754-4-armbru@redhat.com>

On Thu, Jul 17, 2025 at 10:21:16AM +0200, Markus Armbruster wrote:
> "Returns: <description>" is rendered like
> 
>     Return: <Type> – <description>
> 
> Mentioning the type in the description again is commonly redundant.
> There is just one such description.  Rephrase it not to mention the
> type.
> 
> We did this for qapi/ in commit f7296f8de5c (qapi: rephrase return
> docs to avoid type name).
> 
> Signed-off-by: Markus Armbruster <armbru@redhat.com>
> ---
>  qga/qapi-schema.json | 3 +--
>  1 file changed, 1 insertion(+), 2 deletions(-)

Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>


With regards,
Daniel
-- 
|: https://berrange.com      -o-    https://www.flickr.com/photos/dberrange :|
|: https://libvirt.org         -o-            https://fstop138.berrange.com :|
|: https://entangle-photo.org    -o-    https://www.instagram.com/dberrange :|



  reply	other threads:[~2025-07-17  8:30 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-07-17  8:21 [PATCH 0/4] qga: Doc fixes and improvements Markus Armbruster
2025-07-17  8:21 ` [PATCH 1/4] qga: Fix guest-network-get-route return value documentation Markus Armbruster
2025-07-17  8:28   ` Daniel P. Berrangé
2025-07-17  8:21 ` [PATCH 2/4] qga: Remove trivial "Returns:" sections Markus Armbruster
2025-07-17  8:29   ` Daniel P. Berrangé
2025-07-17  8:21 ` [PATCH 3/4] qga: Rephrase return docs to avoid type name Markus Armbruster
2025-07-17  8:29   ` Daniel P. Berrangé [this message]
2025-07-17  8:21 ` [PATCH 4/4] qga: Add cross-references Markus Armbruster
2025-07-17  8:31   ` Daniel P. Berrangé
2025-07-17 10:04     ` Markus Armbruster

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=aHi0hx-z6sgHSFwR@redhat.com \
    --to=berrange@redhat.com \
    --cc=armbru@redhat.com \
    --cc=eblake@redhat.com \
    --cc=jsnow@redhat.com \
    --cc=kkostiuk@redhat.com \
    --cc=michael.roth@amd.com \
    --cc=qemu-devel@nongnu.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 NNTP newsgroup(s).