golang/go

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

Open

#12.794 aperta il 30 set 2015

Vedi su GitHub
 (9 commenti) (0 reazioni) (0 assegnatari)Go (19.008 fork)batch import
Toolshelp wantedpkgsite

Metriche repository

Star
 (133.883 star)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Ispeziona il codice sorgente di pkgsite (o godoc) per capire come determina se un esempio sia eseguibile. Concentrati sulla logica che confronta il nome del pacchetto con il nome base del percorso del pacchetto. Controlla dove viene risolto il percorso di importazione dell'esempio e perché rinominare l'import lo risolve.
Tech stack
go
Dominio
backenddocumentationdeveloper experience
Tipo issue
Bug
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-2 giorni
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Datata
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Go
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
40