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

Mark Sprite constructor as @private in docs? #63

Closed
toolness opened this issue Mar 28, 2016 · 1 comment · Fixed by #67
Closed

Mark Sprite constructor as @private in docs? #63

toolness opened this issue Mar 28, 2016 · 1 comment · Fixed by #67

Comments

@toolness
Copy link
Contributor

I was just reading through the docs and noticed that our Sprite constructor is documented as a public function.

However, another method we have to create sprites is the createSprite function, which actually seems preferable, because it adds the newly-created spite to allSprites. Should we actually deprecate using the Sprite constructor directly, or mention in its documentation that the reader will probably want to use createSprite instead?

@islemaster
Copy link
Contributor

Yes, I suspect we should at least document it as such. I'm not sure it's worth making it entirely inaccessible though.

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 a pull request may close this issue.

2 participants