>>>>> On Fri, 13 Oct 2023, Arthur Zamarin wrote:

> Comments Block
> --------------

> The comments block consists of 2 mandatory parts (`author line`_ and
> `explanation`_) and one optional part (`last-rite epilogue`_). A blank line to
> separate the parts is optional. Trailing whitespace should be dropped.

> The lines in the comment block are prefixed with a "#" symbol. The comments
> should be separated with single space from the "#", unless this is trailing
> whitespace, in which case it should be removed (meaning blank lines in 
> comments
> block are just "#\n").

Maybe flip these two paragraphs? Otherwise it is not entirely clear
whether the "blank line" mentioned in the first paragraph refers to a
true blank line, or to a line consisting of a single number sign.

> The paragraph should be of format ``Removal on ${DATE}. ${BUGS-LIST}``, where
> the date is RFC-3339 full-date format, meaning ``YYYY-MM-DD``, and the bugs
> list is of the `bugs list`_ format. The listed bugs should include the
> last-rite bug opened, and potentially more relevant bugs which weren't listed
> in the explanation paragraphs.

Does this mean that only the first of the following entries would be
valid?

# Removal on 2023-11-13. Bugs #678901, #890123
# Removal on 2023-11-13, bugs #678901, #890123.
# Removal on 2023-11-13. Bugs #678901 #890123

IMHO that would be too restrictive. Punctuation shouldn't be significant
there. (This doesn't preclude _recommending_ one of the variants.)

Ulrich

Attachment: signature.asc
Description: PGP signature

Reply via email to