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

go/doc.ToHTML: "all punctuation" is too restrictive for headers #17564

Closed
rogpeppe opened this issue Oct 24, 2016 · 5 comments
Closed

go/doc.ToHTML: "all punctuation" is too restrictive for headers #17564

rogpeppe opened this issue Oct 24, 2016 · 5 comments
Labels
FrozenDueToAge NeedsDecision Feedback is required from experts, contributors, and/or the community before a change can be made.
Milestone

Comments

@rogpeppe
Copy link
Contributor

go version devel +1af769d Thu Oct 13 06:16:53 2016 +0000 linux/amd64

I wanted a header inside my godoc package comment of the form:

Foo, bar and baz

This doesn't format as a header because of the comma.
No commas in headers seems somewhat overly restrictive.

@bradfitz bradfitz changed the title doc: "all punctuation" is too restrictive for headers x/tools/cmd/godoc: "all punctuation" is too restrictive for headers Oct 24, 2016
@bradfitz
Copy link
Contributor

/cc @robpike

@robpike
Copy link
Contributor

robpike commented Oct 24, 2016

I do not own godoc's rules. @griesemer does.

@quentinmit quentinmit added the NeedsDecision Feedback is required from experts, contributors, and/or the community before a change can be made. label Oct 24, 2016
@quentinmit quentinmit added this to the Go1.8Maybe milestone Oct 24, 2016
@griesemer griesemer changed the title x/tools/cmd/godoc: "all punctuation" is too restrictive for headers go/doc.ToHTML: "all punctuation" is too restrictive for headers Oct 25, 2016
@griesemer griesemer self-assigned this Oct 25, 2016
@griesemer
Copy link
Contributor

This code is in go/doc. I'm reluctant to make changes here. I can easily see that a single line paragraph that uses a comma but misses a period at the end would become a header inadvertently.

Comments anybody?

@robpike
Copy link
Contributor

robpike commented Oct 25, 2016

The rule is simple and easy to understand. I think changing it could be a mistake.

@rsc
Copy link
Contributor

rsc commented Nov 2, 2016

Sounds like there is agreement not to do this. A header "Foo bar and baz" doesn't seem so awful.

@rsc rsc closed this as completed Nov 2, 2016
@golang golang locked and limited conversation to collaborators Nov 2, 2017
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
FrozenDueToAge NeedsDecision Feedback is required from experts, contributors, and/or the community before a change can be made.
Projects
None yet
Development

No branches or pull requests

7 participants