Improving dialog-based acquireToken javadocs #1268
Merged
Conversation
This file contains 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
iambmelt
reviewed
Jul 21, 2018
| * AUTO. | ||
| * | ||
| * acquireToken will authorize an end user to call the specified resource. | ||
| * The minted access token will be sent to the {@link AuthenticationCallback} |
There was a problem hiding this comment.
Note about clarity: "minted" may confuse users into thinking that our library creates access tokens when, in reality, they are given to us.
How about:
- "The access token returned from the STS..."
- "The acquired access token...."
- "The access token"
There was a problem hiding this comment.
Good call out. Fixed.
iambmelt
reviewed
Jul 21, 2018
adal/src/main/java/com/microsoft/aad/adal/AuthenticationContext.java
Outdated
Show resolved
Hide resolved
iambmelt
reviewed
Jul 21, 2018
| * and can be used to call the specified protected resource. | ||
| * By default, acquireToken will attempt to fulfill the request silently, and | ||
| * perform an interactive login if needed or explicitly specified in | ||
| * the request. This overload uses an |
There was a problem hiding this comment.
There are two-spaces after the period in the javadoc. Just a formatting thing.
There was a problem hiding this comment.
Bad habit :)
iambmelt
reviewed
Jul 21, 2018
adal/src/main/java/com/microsoft/aad/adal/AuthenticationContext.java
Outdated
Show resolved
Hide resolved
iambmelt
reviewed
Jul 21, 2018
adal/src/main/java/com/microsoft/aad/adal/AuthenticationContext.java
Outdated
Show resolved
Hide resolved
iambmelt
reviewed
Jul 21, 2018
adal/src/main/java/com/microsoft/aad/adal/AuthenticationContext.java
Outdated
Show resolved
Hide resolved
iambmelt
requested changes
Jul 21, 2018
iambmelt
approved these changes
Aug 31, 2018
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.
Issue: #1267
Improving dialog javadocs by explaining usage, limitations (in this case these overloads do not work with brokered flows), and overall improve the diction.