Consistent headers in rST

Development
1

If you have feelings about us using consistent headers in our rST documentation, either comment on OEP-19: rST consistent headers · Issue #346 · openedx/open-edx-proposals · GitHub, or if you have time, initiate a PR to update OEP-19 and other files in that repo (see issue details). :slight_smile: Thank you!

1 Like
2

I’m not going to argue with consistency, but it’s not clear to me what the alternatives are.

Can you give an example of headers that would need to be changed, to follow this rule? It seems likely my work on the release notes is inconsistent, but I’m not sure sure:

https://github.com/openedx/edx-documentation/blob/master/en_us/open_edx_release_notes/source/nutmeg.rst

Peter Pinch
MIT Open Learning Engineering

3

Thanks Peter. I meant for this to be an announcement and for discussion to happen on the Github issue, so I will move this conversation there.

4

I responded on the issue here: OEP-19: rST consistent headers · Issue #346 · openedx/open-edx-proposals · GitHub