If I view a package's documentation via the web at https://pkg.go.dev, the page includes Example test functions. The output of go doc -u -all for a package does not. Is it possible to have such information included?
3 Answers
It is not possible to display examples using the go doc command.
The command implementation ignores examples.
answered Sep 15, 2022 at 4:13
Godoc examples are snippets of Go code that are displayed as package documentation and that are verified by running them as tests. They can also be run by a user visiting the godoc web page for the package and clicking the associated “Run” button
-
1Thanks for the answer, but what I really wanted was just to see the examples in the terminal output—just like the rest of the go documentation, but I guess the
go doccommand does not allow this. Commented Aug 8, 2023 at 1:06
I installed godoc with:
go install -v golang.org/x/tools/cmd/godoc@latest
And examples (if correctly named) are shown for me. I think you should correctly name your example functions in tests.
-
Thanks for the answer. It's a good answer, but not what I wanted, which was just to see the examples in the terminal, not in my browser. Commented Aug 8, 2023 at 1:04
go doccommand. The command implementation ignores examples.