Being in the same package, the example test file can refer to functions such as <code

A concrete implementation is in <a class="commit-link" data-hovercard-type="commit" da

<a class="user-mention notranslate" data-hovercard-type="user" data-hovercard-url="/us

Change example_gh_test.go to package `gh_test` about go-gh HOT 5 CLOSED

cli commented on June 10, 2024

Change example_gh_test.go to package `gh_test`

from go-gh.

Comments (5)

mntlty commented on June 10, 2024

A concrete implementation is in 114787b in case this makes sense to others

from go-gh.

mislav commented on June 10, 2024

Thanks for bringing this up. Will the examples still get rendered of on the main page of generated docs? If so, I'm in favor of this 👍

from go-gh.

mntlty commented on June 10, 2024

@mislav I ran godoc -http=:6060 on the example branch, and it renders the examples while adding the gh package. Comparing local output for http://localhost:6060/pkg/github.com/cli/go-gh/#example_RESTClient_advanced

From trunk:

opts := api.ClientOptions{
    Host:      "github.com",
    AuthToken: "xxxxxxxxxx", // Replace with valid auth token.
    Headers:   map[string]string{"Time-Zone": "America/Los_Angeles"},
    Log:       os.Stdout,
}
client, err := RESTClient(&opts)
if err != nil {
    log.Fatal(err)
}
response := []struct{ Name string }{}
err = client.Get("repos/cli/cli/tags", &response)
if err != nil {
    log.Fatal(err)
}
fmt.Println(response)

From the example branch:

opts := api.ClientOptions{
    Host:      "github.com",
    AuthToken: "xxxxxxxxxx", // Replace with valid auth token.
    Headers:   map[string]string{"Time-Zone": "America/Los_Angeles"},
    Log:       os.Stdout,
}
client, err := gh.RESTClient(&opts)
if err != nil {
    log.Fatal(err)
}
response := []struct{ Name string }{}
err = client.Get("repos/cli/cli/tags", &response)
if err != nil {
    log.Fatal(err)
}
fmt.Println(response)