Add docblocks to functions and interfaces #132
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
ghost
changed the base branch from
jsor
reviewed
Dec 27, 2018
Member
jsor
left a comment
jsor
left a comment
There was a problem hiding this comment.
Thanks! Since other components also have extensive documentation via docblocks, it makes sense to be consistent 👍
jsor
approved these changes
Jan 7, 2019
ghost
mentioned this pull request
Author
|
@clue ping |
clue
approved these changes
Jan 11, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
This PR simply adds documentation blocks to the promise functions and interfaces. The functions were missing them entirely. For the interfaces I added the description of the method.
As such this PR contains only documentational changes. If merged, this commit should be cherry-picked into the
2.0xbranch.