googleapis / google-auth-library-python

Google Auth Python Library
https://googleapis.dev/python/google-auth/latest/
Apache License 2.0
771 stars 305 forks source link

class oauth2.credentials.Credentials: API documentation is not exact about immutability #1397

Closed eprigorodov closed 10 months ago

eprigorodov commented 11 months ago

The class description contains sentence "The credentials are considered immutable", which is not technically correct: refresh() method updates in place access token and expiration time.

Possible formulation: "The credentials are generally considered immutable, with the exception of the 'refresh()' method"

eprigorodov commented 10 months ago

Thank you for fixing and for the great product.