Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.Sign up
go/doc: lines with double-quotes cannot be headings #31739
What did you do?
Add a package doc like:
What did you expect to see?
What did you see instead?
It shows up as a regular text paragraph. I've also tested simply putting the work Annotation there to exclude the quotes.
This will render the annotations specs as code which acts as a visual divider. Unfortunately the heuristic for detecting sub-titles does not seem to work here (filed a go bug golang/go#31739). Change-Id: I6cd0d01170c3047c03f1a31b260fa0f98e53d296 GitOrigin-RevId: 94f9bf20042b5bf00ac9fb8d4b36cb4da04a7913
See https://godoc.org/go/doc#ToHTML for the rules of what makes a heading: