Conversation
| relnotes_file.write('\n') | ||
| # Items without a type label | ||
| if len(matches) > 0: | ||
| relnotes_file.write("#### General changes\n\n") |
There was a problem hiding this comment.
How does this sort with other type sections?
I would envision it to be like this (with some more non-existent entries that I just came up with)
Changes to the package Singular
General changes
- #5489 Update to Singular.jl 0.27
Optimizations
-#9999 Improve conversion from/to Singular types
If that is the case (i.e. the general changes are always the first type section inside a topic), I would say we can even drop the header, i.e.
| relnotes_file.write("#### General changes\n\n") |
There was a problem hiding this comment.
Right now, the "general changes" is always the last section. (In the logic, the list is "whatever is left over after we have sorted things into sections.")
There was a problem hiding this comment.
It depends a bit on how we use this.
In the context of packages, it is conceivable that often this is the only section anyway; and then having it first without a title makes sense.
But as soon as there are or sections, it feels weird to put the "left overs" at the start.
My preferred solution thus would be:
- if there is no other subsection (so it is both at the start and the end, if you will) then omit the title
- otherwise put it at the end but call the section "Other changes" or "Miscellaneous change" to emphasize these were stuff that did not fit into any other category.
fingolfin
left a comment
There was a problem hiding this comment.
Looks good to me. Let's merge it and try it ;-)
This introduces a section "General changes" for PRs without a type label. It also accounts for PRs without topic labels and without type labels. Fixes the issue @lgoettgens pointed out in #5544 (comment) .
General section looks like
Leftover section looks like