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

crypto/rsa: PublicKey.Equal() should say it expects a pointer #49136

Open
GLAD-DE opened this issue Oct 24, 2021 · 1 comment
Open

crypto/rsa: PublicKey.Equal() should say it expects a pointer #49136

GLAD-DE opened this issue Oct 24, 2021 · 1 comment
Labels
Documentation NeedsDecision

Comments

@GLAD-DE
Copy link

@GLAD-DE GLAD-DE commented Oct 24, 2021

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

$ go version
go version go1.17 linux/amd64

Does this issue reproduce with the latest release?

N/A

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

N/A but included below

go env Output
$ go env
GO111MODULE="on"
GOARCH="amd64"
GOBIN=""
GOCACHE="/home/bernd/.cache/go-build"
GOENV="/home/bernd/.config/go/env"
GOEXE=""
GOEXPERIMENT=""
GOFLAGS=""
GOHOSTARCH="amd64"
GOHOSTOS="linux"
GOINSECURE=""
GOMODCACHE="/home/bernd/go/pkg/mod"
GONOPROXY=""
GONOSUMDB=""
GOOS="linux"
GOPATH="/home/bernd/go"
GOPRIVATE=""
GOPROXY="https://proxy.golang.org,direct"
GOROOT="/usr/local/go"
GOSUMDB="sum.golang.org"
GOTMPDIR=""
GOTOOLDIR="/usr/local/go/pkg/tool/linux_amd64"
GOVCS=""
GOVERSION="go1.17"
GCCGO="gccgo"
AR="ar"
CC="gcc"
CXX="g++"
CGO_ENABLED="1"
GOMOD="/mnt/c/Users/User/Programming/Go/playground/go.mod"
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 -fmessage-length=0 -fdebug-prefix-map=/tmp/go-build1064618544=/tmp/go-build -gno-record-gcc-switches"

What did you do?

N/A

What did you expect to see?

I expected the documentation or the function signature to mention that publicKey.Equal expects a pointer instead of a value.

What did you see instead?

Neither the function signature nor the documentation makes it clear that publicKey.Equal expects a pointer instead of a value

@GLAD-DE GLAD-DE changed the title Update the documentation or the function siganature of rsa.PublicKey.Equal Update the documentation or the function signature of rsa.PublicKey.Equal Oct 24, 2021
@seankhliao seankhliao changed the title Update the documentation or the function signature of rsa.PublicKey.Equal crypto/rsa: PublicKey.Equal() should say it expects a pointer Oct 24, 2021
@seankhliao
Copy link
Member

@seankhliao seankhliao commented Oct 24, 2021

cc @FiloSottile

@seankhliao seankhliao added the NeedsDecision label Oct 24, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation NeedsDecision
Projects
None yet
Development

No branches or pull requests

3 participants