Adding a title in godoc

I am trying to add a title in my godoc. I have referred godoctricks. My godoc looks like below:-

// Package hello-world provides a helloworld example
//
// Pre-requisites
//
//  * Go 1.5+
//  * Linux or MacOS
//  * https://onsi.github.io/ginkgo/ for executing the tests
//
//
package hello_world

But the godoc is showing up as below with Pre-requisites not as title:-

Can someone let me know what is going wrong?

Environment:-

  • Go 1.7
  • Mac OSX El Capitan

Answers


The list seems to cause the problem. You may want to create an issue for that.

If you add any line before listing prerequisites, it will work as expected:

// Package hello-world provides a helloworld example
//
// Pre-requisites
//
// You need to have the following:
//  * Go 1.5+
//  * Linux or MacOS
//  * https://onsi.github.io/ginkgo/ for executing the tests
//
//
package hello_world

Need Your Help

Invalid content was found starting with element 'resources' One of '{"http://www.springframework.org/schema/beans" expected

spring-ws

cvc-complex-type.2.4.a: Invalid content was found starting with element 'resources'. One of '{"http://www.springframework.org/schema/beans":import, "http://

multiple expression/strings in a query

c# regex

Can anyone help with this script please, I am mere mortal not programmer! only the first string expression is working