You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Feels like simply allowing a . is probably too much of a change that could easily trigger changes in the way existing docs are currently rendered. But maybe it's ok to special case a filename, e.g. go.mod, where there is an alpha-numeric either side. Else reject.
Given how significant go.mod and go.sum are in the context of modules, would be a shame to have to come up with alternative headings if we don't want to allow .?
Please answer these questions before submitting your issue. Thanks!
What version of Go are you using (
go version
)?Does this issue reproduce with the latest release?
N/a - testing with tip.
What operating system and processor architecture are you using (
go env
)?What did you do?
then visit:
http://localhost:8080/cmd/go/#hdr-Module_downloading_and_verification
Scroll down slightly to see that "Edit go.mod from tools or scripts" has not been formatted as a heading as it needs to be.
What did you expect to see?
"Edit go.mod from tools or scripts" formatted as a heading, so that I can see the section but also link to it (which is how I came across this).
What did you see instead?
This is ultimately because headings are currently not allowed to contain a period (
.
):go/src/go/doc/comment.go
Line 235 in 5c11480
Feels like simply allowing a
.
is probably too much of a change that could easily trigger changes in the way existing docs are currently rendered. But maybe it's ok to special case a filename, e.g.go.mod
, where there is an alpha-numeric either side. Else reject.Given how significant
go.mod
andgo.sum
are in the context of modules, would be a shame to have to come up with alternative headings if we don't want to allow.
?/cc @rsc @griesemer
The text was updated successfully, but these errors were encountered: