Implement ESDoc #226
Merged
Implement ESDoc #226
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
src/js/step.js
Outdated
|
|
||
| /** | ||
| * Wraps `_show` and ensures `beforeShowPromise` resolves before calling show | ||
| * @return {*} |
There was a problem hiding this comment.
does esdoc not support {Promise} here as the returned value?
There was a problem hiding this comment.
It does, we don't always return a promise though, if beforeShowPromise is not a function.
src/js/step.js
Outdated
| /** | ||
| * Determines button options prior to rendering | ||
| * | ||
| * @private |
There was a problem hiding this comment.
still should have @return for readability
| /** | ||
| * Setup a new step object | ||
| * @param {Object} stepOptions The object describing the options for the step | ||
| * @param {String|Number} name The string or number to use as the `id` for the step |
There was a problem hiding this comment.
seems like type should be limited here
There was a problem hiding this comment.
Both numbers and strings are supported
RobbieTheWagner
force-pushed
the
esdocs
branch
from
d984eab
to
0977210
Compare
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.
No description provided.