Skip to content

Change the formatting guidance for level-one headers #49

@mbcann01

Description

@mbcann01

Overview

In Epi III, I used the following formatting guideline:

There should be 2 line breaks (returns) immediately above level-one headers. There should be 1 line break (return) immediately above all other headers.

This was my attempt to make my code easier to read, but at the end of the day, I don't think it accomplishes that goal.

  • There isn't a big difference in the way the code looks in the source file when we use two returns vs. one return.
  • There is literally no difference at all in the rendered file (e.g., HTML).
  • It confuses people and/or they forget to do it.

I am going to remove that guidance and replace it with:

There should be 1 line break (returns) immediately above all headers.

I am mostly just creating this issue in case I ever need to go look up when or why I made this change.

Metadata

Metadata

Assignees

Labels

bugSomething isn't working

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions