x/tools/cmd/godoc: single file examples are not displayed in package main like godoc.org

[nhooyr]

see golang/gddo#132

This issue was never fixed in the godoc tool.

Compare https://godoc.org/nhooyr.io/websocket#ex-package--Echo

to locally

[LaPingvino]

I just found this issue when I got pinged because of issue golang/gddo#614, maybe a good idea to try to fix these together... Probably just applying the patch in issue golang/gddo#132 could solve this issue, but the other issue might still be present by doing this. I might give this one a go in the next few hours...

[LaPingvino]

Copying over my question in the gddo-issue: does anyone know why the Play method strips comments? Could this be changed to enable the fix for gddo to be backported to the godoc implementation and have expected comment-behavior?

[dmitshur]

maybe a good idea to try to fix these together

The plan is to indeed try to fix these together as part of the effort to unify Go package documentation rendering and adding module support to x/tools/cmd/godoc and gddo (issue #26827).

[dmitshur]

I think the reported example may have changed so it's hard to tell, but I expect this should be fixed on pkg.go.dev now. godoc is deprecated in favor of golang.org/x/pkgsite/cmd/pkgsite (see #49212), so closing this issue.