Marc-André Lureau <marcandre.lur...@redhat.com> writes:

> Have the TODO in the TAG: format, so they will stand out in the
> generated documentation.

I expect TODO without colon to creep back.  Right now, we have three
with and three without colon.  Whack-a-mole is a stupid game, but since
these moles are fairly harmless, I don't care.

The commit message is sub-optimal, though.  At this point, there is no
generated documentation, and we have no concept of "named-sections".
Let's instead say

  qapi: Format TODO comments more consistently

  Consistently put a colon after TODO.  This will make the TODOs stand
  out in the documentation we're going to generate.

With that
Reviewed-by: Markus Armbruster <arm...@redhat.com>

Alternatively, delay the patch until after we generate documentation.

Reply via email to