Skip to content

Improve JSDoc to match code#1132

Merged
abetomo merged 1 commit intotj:developfrom
shadowspawn:feature/tidy-js-2
Jan 4, 2020
Merged

Improve JSDoc to match code#1132
abetomo merged 1 commit intotj:developfrom
shadowspawn:feature/tidy-js-2

Conversation

@shadowspawn
Copy link
Collaborator

@shadowspawn shadowspawn commented Dec 30, 2019

Pull Request

Using Typescript to check the Javascript identifies a lot of minor issues. This PR addresses most errors in the JSDoc.

(Previous abandoned #1120 also included code changes.)

Problem

JSDoc issues are displayed when check index.js with TypeScript:

npx tsc --allowJS --checkJS index.js --noEmit
...
Found 53 errors.

or by adding comment to index.js in Visual Studio Code:

// @ts-check

Solution

Make minor changes to the JSDoc to fix parameter names and types to match code.

npx tsc --allowJS --checkJS index.js --noEmit
...
Found 35 errors.

Copy link
Collaborator

@abetomo abetomo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the update.

@abetomo abetomo merged commit 1d9cc72 into tj:develop Jan 4, 2020
@shadowspawn shadowspawn deleted the feature/tidy-js-2 branch January 5, 2020 01:57
@shadowspawn shadowspawn added pending release Merged into a branch for a future release, but not released yet and removed pending release Merged into a branch for a future release, but not released yet labels Jan 5, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants