pkg.go.dev Documentation section empty

83 views
Skip to first unread message

Tong Sun

unread,
Mar 18, 2021, 7:10:43 PM3/18/21
to golang-nuts
The "Documentation" section is empty for my package on pkg.go.dev

Where can I read how to fix it?

Thanks


Axel Wagner

unread,
Mar 18, 2021, 7:31:36 PM3/18/21
to Tong Sun, golang-nuts
Hi,

https://go.dev/about#adding-a-package gives general information about adding a module.
One of the most common reasons why documentation might not show up is that your module doesn't contain an open source license that pkg.go.dev recognizes. https://pkg.go.dev/license-policy contains some information on that.
If you provide us with a link to your module, we might be able to give you more specific information about what is wrong.

--
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...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/golang-nuts/88896681-cac3-4dac-bf4b-568b5cd8c5c4n%40googlegroups.com.

Tong Sun

unread,
Mar 18, 2021, 11:57:01 PM3/18/21
to golang-nuts
( Sorry Alex, didn't meant to sent to you personally )

Oh, thanks. Just realized that the Documentation section is only for
modules, right?

I.e., mine is an executable, and this is the first time I'm looking at
my docs on pkg.go.dev, in which my long readme is "missing", the whole
page is almost empty, with the gopher-flying-airplane picture taking
the majority of the empty space, until just now I realized that I
should click on that "Expand" button. Sorry...
Reply all
Reply to author
Forward
0 new messages