go icon indicating copy to clipboard operation
go copied to clipboard

go/doc: Examples not executable if pkg.name != basename(pkg.path)

Open alandonovan opened this issue 10 years ago • 5 comments

% export GOPATH=$(pwd) % cat src/foo1/foo.go package foo

func Foo() { }

% cat src/foo1/foo_test.go package foo_test

import "foo1" // defines foo

func ExampleFoo() { foo.Foo() }

% godoc -play -http :9999 & % open http://localhost:9999/pkg/foo1/#pkg-examples

The example is shown but not executable (grey not yellow); renaming foo1 to foo makes it executable, as does using an explicit (redundant) renaming import: import foo "foo1"

Seems like some code in godoc is assuming pkg.name == basename(pkg.path) instead of finding the actual package name.

alandonovan avatar Sep 30 '15 14:09 alandonovan