On Tuesday, 21 November 2017 21:26:56 UTC+1, simon place wrote: > > see; > > https://play.golang.org/p/kPWJzm1rQi > > see comments for details, found more than i banked on whilst investigating > a formatting issue on GitHub docs (turned out to be example 7.). >
Just some thoughts and my opinion: Spurious newlines: The generated HTML is not beautified at all and it is not intended to be processed by humans but by HTML parsers which do not care about these extra newlines. So why bother? Regarding the id attributes. They are undocumented but what is wrong with this? It just means it is not falling under the compatibility guarantee and can be changed if needed. What problem would be solved if the id attributes were documented in detail? Example seven (and five): Because two headlines after each other is not supported. The documentation is a bit lacking here, it does not describe the whole algorithm and all edge cases in detail. A span is made a headline given the rules stated in the documentation and the implicit rule that headlines must be separated by paragraphs and the convention that the godoc starts with a full sentence describing the type/function/method/variable/constant and thus never starts with a heading. Again: What would be gained by documenting this in full detail? V. -- You received this message because you are subscribed to the Google Groups "golang-nuts" group. To unsubscribe from this group and stop receiving emails from it, send an email to golang-nuts+unsubscr...@googlegroups.com. For more options, visit https://groups.google.com/d/optout.