sympy / sympy-bot

GitHub bot for SymPy
https://github.com/sympy-bot
Other
22 stars 11 forks source link

Render the submodule headers as Markdown headers? #64

Open asmeurer opened 5 years ago

asmeurer commented 5 years ago

The release notes may look better if instead of formatting it like

* core
  * change 1
  * change 2
* solvers
  * change 1
  * change 2

we instead used Markdown headers, like

core

#### core
* change 1
* change 2
#### solvers
* change 1
* change 2

It may also be easier for people to write release notes in this format, al they won't have to deal with nested bullets.

Finally, this would allow linking to the notes for a specific submodule, since every Markdown header gets an anchor.

Level 4 headers may be better level 3. Level 4 renders the same as just bold text, but with an anchor.

asmeurer commented 5 years ago

Although as for people writing the notes like this in the PR template, they would probably get confused by the header level, and write notes like

core

So that may not be a great idea.