Skip to content
This repository has been archived by the owner on Jun 21, 2022. It is now read-only.

docs: Add JSDoc to all built‑in library files #1077

Closed
wants to merge 9 commits into from

Conversation

ExE-Boss
Copy link
Contributor

@ExE-Boss ExE-Boss commented Feb 14, 2019

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)

@ExE-Boss 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
@ExE-Boss
Copy link
Contributor Author

Travis is acting up, again…

if (!fUrl.host) {
var p = url.parse(this.env.url, true);
var p = URL.parse(this.env.url, true);
Copy link
Contributor Author

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.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants