golang/go

x/pkgsite/cmd/pkgsite: Examples not executable if pkg.name != basename(pkg.path)

Open

#12,794 opened on Sep 30, 2015

View on GitHub
 (9 comments) (0 reactions) (0 assignees)Go (19,008 forks)batch import
Toolshelp wantedpkgsite

Repository metrics

Stars
 (133,883 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Update: see https://github.com/golang/go/issues/12794#issuecomment-3667366323

% 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.

Contributor guide

Research direction
Inspect the source code of pkgsite (or godoc) to understand how it determines whether an example is executable. Focus on the logic that compares the package name with the basename of the package path. Check where the example's import path is resolved and why renaming import fixes it.
Tech stack
go
Domain
backenddocumentationdeveloper experience
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Go
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40