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.

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

archive/zip: documentation refers to io.FS instead of fs.FS #42374

Closed
artyom opened this issue Nov 4, 2020 · 1 comment
Closed

archive/zip: documentation refers to io.FS instead of fs.FS #42374

artyom opened this issue Nov 4, 2020 · 1 comment
Labels
Documentation FrozenDueToAge NeedsFix The path to resolution is known, but the work has not been done.
Milestone
Go1.16

Comments

@artyom
Copy link
Member

artyom commented Nov 4, 2020

What version of Go are you using (go version)?

$ go version
go version devel +633f9e2060 Wed Nov 4 06:42:33 2020 +0000 darwin/amd64

Does this issue reproduce with the latest release?

Yes

What operating system and processor architecture are you using (go env)?

go env Output
$ go env
GO111MODULE="on"
GOARCH="amd64"
GOBIN=""
GOCACHE="/Users/artyom/Library/Caches/go-build"
GOENV="/Users/artyom/Library/Application Support/go/env"
GOEXE=""
GOFLAGS="-ldflags=-w -trimpath"
GOHOSTARCH="amd64"
GOHOSTOS="darwin"
GOINSECURE=""
GOMODCACHE="/Users/artyom/go/pkg/mod"
GONOPROXY=""
GONOSUMDB=""
GOOS="darwin"
GOPATH="/Users/artyom/go"
GOPRIVATE=""
GOPROXY="https://proxy.golang.org,direct"
GOROOT="/Users/artyom/Repositories/go"
GOSUMDB="sum.golang.org"
GOTMPDIR=""
GOTOOLDIR="/Users/artyom/Repositories/go/pkg/tool/darwin_amd64"
GCCGO="gccgo"
AR="ar"
CC="clang"
CXX="clang++"
CGO_ENABLED="1"
GOMOD="/dev/null"
CGO_CFLAGS="-g -O2"
CGO_CPPFLAGS=""
CGO_CXXFLAGS="-g -O2"
CGO_FFLAGS="-g -O2"
CGO_LDFLAGS="-g -O2"
PKG_CONFIG="pkg-config"
GOGCCFLAGS="-fPIC -m64 -pthread -fno-caret-diagnostics -Qunused-arguments -fmessage-length=0 -fdebug-prefix-map=/var/folders/lb/3rk8rqs53czgb4v35w_342xc0000gn/T/go-build536273506=/tmp/go-build -gno-record-gcc-switches -fno-common"

What did you do?

Checked archive/zip documentation to see whether package implements newly added FS interface:

go (master) ¶ ./bin/go doc -all archive/zip | grep -C2 FS
func (r *Reader) Open(name string) (fs.File, error)
    Open opens the named file in the ZIP archive, using the semantics of
    io.FS.Open: paths are always slash separated, with no leading / or ../
    elements.

What did you expect to see?

Documentation mentions fs.FS interface

What did you see instead?

Documentation refers to non-existing io.FS
@gopherbot
Copy link

Change https://golang.org/cl/267657 mentions this issue: archive/zip: fix documentation to mention fs.FS interface

@toothrot toothrot added this to the Backlog milestone Nov 6, 2020
@toothrot toothrot added the NeedsFix The path to resolution is known, but the work has not been done. label Nov 6, 2020
@dmitshur dmitshur modified the milestones: Backlog, Go1.16 Nov 7, 2020
@golang golang locked and limited conversation to collaborators Nov 7, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
Documentation FrozenDueToAge NeedsFix The path to resolution is known, but the work has not been done.
Projects
None yet
Milestone
Go1.16
Development

No branches or pull requests
4 participants
@toothrot @artyom @dmitshur @gopherbot