Add js docs for Authentication package #405
Merged
Conversation
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
bajtos
suggested changes
Jun 27, 2017
|
|
||
| /* class to hold authentication metadata | ||
| /** | ||
| * @summary interface to hold authentication metadata |
There was a problem hiding this comment.
I don't think we are using @summary anywhere else, what is the benefit of using it in this place?
packages/authentication/src/keys.ts
Outdated
| // License text available at https://opensource.org/licenses/MIT | ||
|
|
||
| /** | ||
| * @summary namespace for constants and keys for authentication |
packages/context/src/binding.ts
Outdated
| * Bind the key to a BindingProvider | ||
| * Bind the key to a Provider class | ||
| * | ||
| * @param provider - the class constructor of a value provider |
There was a problem hiding this comment.
Please remove - from between the parameter name and its description.
@param provider The class constructor of a value provider
| * Bind the key to a Provider class | ||
| * | ||
| * @param provider - the class constructor of a value provider | ||
| */ |
There was a problem hiding this comment.
Can you please add an small code example showing a custom Provider class and how it is bound?
|
@deepakrkris ping |
Also improve api docs for context package.
bajtos
approved these changes
Aug 4, 2017
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
cc @bajtos @raymondfeng @ritch @superkhau
Closes #370