Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jsdoc #588

Merged
merged 4 commits into from
Oct 7, 2019
Merged

Jsdoc #588

merged 4 commits into from
Oct 7, 2019

Conversation

brettz9
Copy link
Contributor

@brettz9 brettz9 commented Oct 6, 2019

  • Use standard jsdoc tags and casing, denoting optional items (and add some types/return values)
  • Minor refactoring: Remove options check in npm.js' defaultPrefix function as function does not later allow a non-object anyways
  • Minor refactoring: Avoid else after throw

There is still one non-standard jsdoc-style tag you have in place (@sideeffects), but I didn't change that as there is no standard equivalent (there is a @modifies tag, but that is for side effects on objects) and JSDoc does allow custom tags.

…ix` function as function does not later allow a non-object anyways

- Minor refactoring: Avoid else after throw
@brettz9
Copy link
Contributor Author

brettz9 commented Oct 6, 2019

Greater specificity could be added for some of the types, but I figure that could be added as time goes on.

@raineorshine raineorshine merged commit 82dc319 into raineorshine:master Oct 7, 2019
@brettz9 brettz9 deleted the jsdoc branch October 7, 2019 02:33
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.

None yet

2 participants