Markus Armbruster <arm...@redhat.com> writes: > John Snow <js...@redhat.com> writes: > >> Well, I tried. Maybe not very hard. Sorry! > > Recommend to explain *why* we want to avoid the type name. > > "Returns: <description>" is rendered like "Return: <Type> – > <description>". Mentioning the type in the description again is > commonly redundant. Rephrase such descriptions not to. > >> Signed-off-by: John Snow <js...@redhat.com>
[...] > I need to stop here to take care of another series. Gut feeling so far: > right direction, doesn't go far enough. > > Choices: > > * Go far enough. Too close to the freeze for that, I'm afraid. > > * Merge it basically as is, come back later to finish the job. Let's pick this one, then try to improve on top. > * Drop it for now, adjust your "QAPI: add cross-references to qapi docs" > to enclose the type names not removed in `backquotes`. > > Thoughts? > > [...] Acked-by: Markus Armbruster <arm...@redhat.com>
