go101/golds

package level godoc missing

jmccormick2001 opened this issue · 2 comments

question about godoc, in my file, dataprov.go, I have package level godoc like this:

// Package dataprov holds the data provenance logic which is essentially
// used to identify each data source uniquely with a generated ID
// that is passed with all processed data so users can track data back
// to its source
package dataprov

however, when I generate and few the docs for this package I'm not seeing the package godoc
at all...question, is package level godoc text supposed to be present in the generated page?

thanks.

is package level godoc text supposed to be present in the generated page?

It is not supposed to be present in the package details page.

We can view package docs by clicking the "d->" in front of some listed source code files. This is a deliberate design, as it is recommended to read docs directly in code by the design of Gold.

However, Gold is still in its experimental phase. If many people don't like the design, it can be changed later.

thanks