Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Go library examples in docs don't work #4703

Closed
philrz opened this issue Jul 6, 2023 · 1 comment · Fixed by #5095 or #5147
Closed

Go library examples in docs don't work #4703

philrz opened this issue Jul 6, 2023 · 1 comment · Fixed by #5095 or #5147
Assignees
@mattnibs
Labels
bug Something isn't working

Comments

@philrz
Copy link
Contributor

philrz commented Jul 6, 2023 •
edited

Repro is with Zed commit 7ba4ecc.

I'm not much of a Go developer, but I was hacking a bit and tried working off the user-facing docs. However, what's shown there doesn't currently work. Starting with what's shown for just the top ZSON Reader example:

$ mkdir example

$ cd example

$ go mod init example
go: creating new go.mod: module example

$ cat > main.go
# [pasted the example from the docs]

$ go mod tidy
go: finding module for package github.com/brimdata/zed/zson
go: finding module for package github.com/brimdata/zed
go: finding module for package github.com/brimdata/zed/zio/zsonio
go: found github.com/brimdata/zed in github.com/brimdata/zed v1.8.1
go: found github.com/brimdata/zed/zio/zsonio in github.com/brimdata/zed v1.8.1
go: found github.com/brimdata/zed/zson in github.com/brimdata/zed v1.8.1

$ echo '{s:"hello"}{x:123}{s:"world"}' | go run .
# example
./main.go:15:32: cannot use os.Stdin (variable of type *os.File) as *"github.com/brimdata/zed".Context value in argument to zsonio.NewReader
./main.go:15:42: cannot use zctx (variable of type *"github.com/brimdata/zed".Context) as io.Reader value in argument to zsonio.NewReader: *"github.com/brimdata/zed".Context does not implement io.Reader (missing method Read)
@philrz philrz added the bug Something isn't working label Jul 6, 2023
mattnibs added a commit that referenced this issue Apr 1, 2024
@mattnibs
Test Go Library Examples
67628a1 
Add markdown test to run go vet on go library examples. Fix existing go
library examples.

Closes #4703
@mattnibs mattnibs mentioned this issue Apr 1, 2024
Merged
mattnibs added a commit that referenced this issue Apr 1, 2024
@mattnibs
Test Go Library Examples
153b785 
Add markdown test to run go vet on go library examples. Fix existing go
library examples.

Closes #4703
mattnibs added a commit that referenced this issue Jun 19, 2024
@mattnibs
Test Go Library Examples
3bce435 
Add markdown test to run go vet on go library examples. Fix existing go
library examples.

Closes #4703
@philrz philrz linked a pull request Jun 20, 2024 that will close this issue
Mention the re-run of "go mod tidy" #5147
Merged
@philrz
Copy link
Contributor Author

philrz commented Jun 20, 2024

I've verified this by working off the docs deployment triggered by Zed commit c014c91.

As a user, I can now successfully run through the Go library examples in the docs. The only two gotchas I experienced:

  1. They're written with the current tip-of-main Zed in mind, but following the instructions as written will currently pull the last tagged Zed release v1.15.0 such that the examples fail when run. Therefore to test I manually updated the Zed dependency in the go.mod to a recent commit:

    require github.com/brimdata/zed v1.15.1-0.20240620170635-36a18e91a5d6

    ...and re-ran go mod tidy before running the example.

    This problem will go away when we tag the next GA Zed release.

  2. Moving on to the second example required a re-run of go mod tidy, but that's a small change for which I've put up a proposed change in Mention the re-run of "go mod tidy" #5147.

Thanks @mattnibs!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@mattnibs mattnibs

Labels
bug Something isn't working
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Test Go Library Examples brimdata/zed
Mention the re-run of "go mod tidy" brimdata/zed
2 participants
@mattnibs @philrz