This repository has been archived by the owner on Jun 21, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 175
docs: Add JSDoc to all built‑in library files #1077
Closed
Closed
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
ExE-Boss
changed the title
docs: Add JSDoc to all built‑in library files [WIP]
docs: Add JSDoc to all built‑in library files
Feb 24, 2019
Travis is acting up, again… |
ExE-Boss
force-pushed
the
jsdoc
branch
2 times, most recently
from
February 24, 2019 22:51
274e03e
to
8c84b67
Compare
ExE-Boss
commented
Feb 24, 2019
if (!fUrl.host) { | ||
var p = url.parse(this.env.url, true); | ||
var p = URL.parse(this.env.url, true); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Previously, this would try to call String.prototype.parse
, which doesn’t exist, causing a TypeError
to be thrown.
I discovered this thanks to: https://medium.com/@trukrs/type-safe-javascript-with-jsdoc-7a2a63209b76.
9 tasks
This was referenced Mar 28, 2019
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
I had originally opened #959 way back, but some of the JSDoc comments were converted to plain comments without type information in #1035, this restores all of them and adds new ones.
review?(@davidflanagan, @Elchi3, @wbamberg)