go/doc: lines ending with parenthesis cannot be headings #34377
Labels
NeedsDecision
Feedback is required from experts, contributors, and/or the community before a change can be made.
Thinking
Milestone
What did you do?
Add a package doc like:
// ...
// Create a snapshot from a source table (snapshots alpha)
//
// cbt createsnapshot <cluster> <snapshot> <table> [ttl=<d>]
// ...
What did you expect to see?
The string "Create a snapshot..." should be a title since it is delimited by blank lines, starts with and uppercase letter and does not end with an invalid punctuation.
What did you see instead?
It shows up as a regular text paragraph.
Can be seen here: https://godoc.org/google.golang.org/cloud/bigtable/cmd/cbt#hdr-Block_until_all_the_completed_writes_have_been_replicated_to_all_the_clusters
cc: @dmitshur
The text was updated successfully, but these errors were encountered: