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

Correct JSDoc for NodeElementService #3

Open
neocotic opened this issue Jun 8, 2017 · 0 comments
Open

Correct JSDoc for NodeElementService #3

neocotic opened this issue Jun 8, 2017 · 0 comments

Comments

@neocotic
Copy link
Owner

neocotic commented Jun 8, 2017

The following is currently the JSDoc associated with NodeElementService:

/**
 * An implementation of {@link ElementService} intended for use within a Node.js environment but is only supported when
 * the <code>canvas</code> module has also been depended on.
 *
 * @public
 * @class
 * @extends ElementService
 */

It suggests that its usage is potentially conditional based on canvas being available. This might have been the case before splitting into modules, but now canvas is a hard dependency so it must be available. This JSDoc needs to be updated to reflect that.

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

No branches or pull requests

1 participant