Join GitHub today
GitHub is home to over 40 million developers working together to host and review code, manage projects, and build software together.Sign up
cmd/vet: ugly section headings in godoc html #7925
http://godoc.org/code.google.com/p/go.tools/cmd/vet The Flag lines are treated as headers, while the numbered section headings above them are not. There's tension here with good-looking plain text docs. Options include removing the numbered section heading, making the numbered section headings all caps, and reworking the structure entirely.
The current heading selection treats lines with "." as not-a-heading. The initial suggestion on heading was less focused on characters deemed unsuitable for a heading and used 2 preceding blank lines as a heading indicator. This was rejected as it might be considered setting a precedent for writing markup. Are two blank lines still considered "markup"? Allowing (in addition to the current, selective rules) two blank lines to indicate "next line is heading" would solve this issue and issue #7349 as well. (And I still like the visual gap in plaintext code.)
This issue was closed.