oauth2 icon indicating copy to clipboard operation
oauth2 copied to clipboard

x/oauth2: clarify that ExpiresIn is not automatically populated by the package

Open soh335 opened this issue 1 year ago • 6 comments

Added a note to the ExpiresIn field documentation to clarify that the oauth2 package does not automatically populate the ExpiresIn field, even if the server returns an "expires_in" value. This change helps prevent confusion for developers expecting ExpiresInto be set when interacting with methods likeConfig.Exchange`.

soh335 avatar Oct 20 '24 01:10 soh335

This PR (HEAD: 71e6027a5f3e490c83c399bf1950cdf5e5384bc8) has been imported to Gerrit for code review.

Please visit Gerrit at https://go-review.googlesource.com/c/oauth2/+/621195.

Important tips:

  • Don't comment on this PR. All discussion takes place in Gerrit.
  • You need a Gmail or other Google account to log in to Gerrit.
  • To change your code in response to feedback:
    • Push a new commit to the branch used by your GitHub PR.
    • A new "patch set" will then appear in Gerrit.
    • Respond to each comment by marking as Done in Gerrit if implemented as suggested. You can alternatively write a reply.
    • Critical: you must click the blue Reply button near the top to publish your Gerrit responses.
    • Multiple commits in the PR will be squashed by GerritBot.
  • The title and description of the GitHub PR are used to construct the final commit message.
    • Edit these as needed via the GitHub web interface (not via Gerrit or git).
    • You should word wrap the PR description at ~76 characters unless you need longer lines (e.g., for tables or URLs).
  • See the Sending a change via GitHub and Reviews sections of the Contribution Guide as well as the FAQ for details.

gopherbot avatar Oct 20 '24 01:10 gopherbot

Message from Gopher Robot:

Patch Set 1:

(1 comment)


Please don’t reply on this GitHub thread. Visit golang.org/cl/621195. After addressing review feedback, remember to publish your drafts!

gopherbot avatar Oct 20 '24 01:10 gopherbot

Message from Gopher Robot:

Patch Set 1:

Congratulations on opening your first change. Thank you for your contribution!

Next steps: A maintainer will review your change and provide feedback. See https://go.dev/doc/contribute#review for more info and tips to get your patch through code review.

Most changes in the Go project go through a few rounds of revision. This can be surprising to people new to the project. The careful, iterative review process is our way of helping mentor contributors and ensuring that their contributions have a lasting impact.


Please don’t reply on this GitHub thread. Visit golang.org/cl/621195. After addressing review feedback, remember to publish your drafts!

gopherbot avatar Oct 20 '24 01:10 gopherbot

This PR (HEAD: 117a894f8800b0aa07ab2f96fa13405f2a1a8ab6) has been imported to Gerrit for code review.

Please visit Gerrit at https://go-review.googlesource.com/c/oauth2/+/621195.

Important tips:

  • Don't comment on this PR. All discussion takes place in Gerrit.
  • You need a Gmail or other Google account to log in to Gerrit.
  • To change your code in response to feedback:
    • Push a new commit to the branch used by your GitHub PR.
    • A new "patch set" will then appear in Gerrit.
    • Respond to each comment by marking as Done in Gerrit if implemented as suggested. You can alternatively write a reply.
    • Critical: you must click the blue Reply button near the top to publish your Gerrit responses.
    • Multiple commits in the PR will be squashed by GerritBot.
  • The title and description of the GitHub PR are used to construct the final commit message.
    • Edit these as needed via the GitHub web interface (not via Gerrit or git).
    • You should word wrap the PR description at ~76 characters unless you need longer lines (e.g., for tables or URLs).
  • See the Sending a change via GitHub and Reviews sections of the Contribution Guide as well as the FAQ for details.

gopherbot avatar Oct 28 '24 13:10 gopherbot

This change may get obsoleted by https://github.com/golang/oauth2/pull/748

peick avatar Jan 05 '25 12:01 peick

IMO, I'd merge the doc change in so users have a chance to be aware of this by reading the docs.

The respective doc change to remove it can follow the merge of #748.

kaden-l-nelson avatar Aug 31 '25 20:08 kaden-l-nelson