jwt icon indicating copy to clipboard operation
jwt copied to clipboard

Token.New example is for the wrong func

Open notrobpike opened this issue 1 year ago • 2 comments

The example for Token.New() actually demonstrates Token.NewWithClaims(). It should be demonstrating Token.New().

It additionally demonstrates signing, which I guess is ok but it seems out of scope, given that the signing example can just be part of the documentation for that method ...

notrobpike avatar Aug 15 '23 18:08 notrobpike

The example for Token.New() actually demonstrates Token.NewWithClaims(). It should be demonstrating Token.New().

It additionally demonstrates signing, which I guess is ok but it seems out of scope, given that the signing example can just be part of the documentation for that method ...

Which example are you exactly referring to? The ones in example_test.go use NewWithClaims, but are also named in this way.

oxisto avatar Aug 16 '23 05:08 oxisto

https://github.com/golang-jwt/jwt/blob/v5.0.0/hmac_example_test.go#L26

which generates https://pkg.go.dev/github.com/golang-jwt/jwt/v5#New

notrobpike avatar Aug 17 '23 03:08 notrobpike