For whatever reason we started writing our headers in our docs with:

Header
======

Subheader
---------

SubSubHeader
~~~~~~~~~~~~

as opposed to the alternative:

= This Is A Header

== Subheader

=== SubSubHeader

The downside with the first approach is that it forces us to do two things:

1. Remember the syntax for each header layer (which we all probably know
pretty well at this point, but still...)
2. Ensure that the width of the header formatting line is equal to the
length of the text above it.

That second point is a killer sometimes. While I've trained myself to be
good at noticing that problem I know it's bitten us in releases over and
over and over again.

Anyway, I think going to the alternative formatting would be better and
propose to do a full reformatting. Please let me know if there are any
concerns about doing that - if I don't hear back in the next few days I'll
proceed with the changes.

Thanks,

Stephen

Reply via email to