doc(oauth2): name the constructor parameter these classes actually take - #16336
Open
karpovantonme wants to merge 1 commit into
Open
doc(oauth2): name the constructor parameter these classes actually take#16336karpovantonme wants to merge 1 commit into
karpovantonme wants to merge 1 commit into
Conversation
The four credential constructors document a rest_client and a current_time_fn. Neither has existed since the client factory replaced them, so Doxygen drops the description and client_factory is left undocumented.
There was a problem hiding this comment.
Code Review
This pull request updates the Doxygen documentation across several OAuth2 credentials header files to reflect the transition from using rest_client or current_time_fn parameters to client_factory. There are no review comments, and I have no feedback to provide.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Four credential constructors document parameters they do not take:
rest_clientis gone, and so iscurrent_time_fnin the other two. The injection point they describe is nowclient_factory, so Doxygen drops the description as belonging to nothing and the parameter that is actually there ends up undocumented.Same shape in
AuthorizedUserCredentials,ComputeEngineCredentials,ImpersonateServiceAccountCredentialsandServiceAccountCredentials. Renamed the names, kept the wording each file already used, no behaviour touched.