Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

cmd/vet: ugly section headings in godoc html #7925

Closed
josharian opened this issue May 2, 2014 · 4 comments
Closed

cmd/vet: ugly section headings in godoc html #7925

josharian opened this issue May 2, 2014 · 4 comments
Labels
Documentation FrozenDueToAge

Comments

@josharian
Copy link
Contributor 

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.
@robpike
Copy link
Contributor

robpike commented May 2, 2014

Comment 1:

Owner changed to @robpike.

@vdobler
Copy link
Contributor

vdobler commented May 7, 2014

Comment 2:

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.)

@gopherbot
Copy link

Comment 3:

CL https://golang.org/cl/98370044 mentions this issue.

@robpike
Copy link
Contributor

robpike commented May 19, 2014

Comment 4:

This issue was closed by revision golang/tools@4374c89.

Status changed to Fixed.

@golang golang locked and limited conversation to collaborators Jun 25, 2016
@rsc rsc unassigned robpike Jun 23, 2022
This issue was closed.
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
Documentation FrozenDueToAge
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@josharian @vdobler @robpike @gopherbot