John Snow <js...@redhat.com> writes: > On Fri, Mar 7, 2025 at 2:48 AM Markus Armbruster <arm...@redhat.com> wrote: > >> John Snow <js...@redhat.com> writes: >> >> > ``:error: descr`` can now be used to document error conditions. The >> > format of the description is not defined here; so the ability to name >> > specific types is left to the document writer. >> > >> > Signed-off-by: John Snow <js...@redhat.com> >> >> By convention, the description is a bullet list, but we don't enforce >> that in software. Observation, not a suggestion to start enforcing it >> now. >> > > Right. This commit message is accurate, though: this field list type will > accept any old thing. I have an idea to fix this to make the aesthetics > better (fixes the misalignment) and to enforce the bulleted list in one > shot. Not for this series, sorry. Please accept a raincheck.
You're quite right to resist mission creep. The commit message could mention the convention, say "The format of the description is not defined here (we make it a bulleted list, but that's just convention); ..." Up to you.
