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

Better clarity in docs about properties #235

Closed
iamjoshua opened this issue Apr 10, 2016 · 0 comments
Closed

Better clarity in docs about properties #235

iamjoshua opened this issue Apr 10, 2016 · 0 comments
Labels

Comments

@iamjoshua
Copy link
Contributor

This is a minor issue, but the docs seem a bit too cavalier about the body type property:
http://brm.io/matter-js/docs/classes/Body.html

It's included with a bunch of other editable properties that seem to imply that it can be modified at will. However, it seems that this attribute absolutely should not be changed since the Composite class depends upon it:

switch (obj.type) {

I just spent some time trying to figure out why Composite.remove stopped working after some recent changes that I made. I have many different object types in my project, so seeing this field in the docs I happily changed it to match...

It might be nice to add a Readonly header to properties like these in the docs.

Just some feedback. Overall, I've found working with Matter to be a great experience!

@liabru liabru added the task label Apr 12, 2016
@liabru liabru closed this as completed in afd7531 Apr 19, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants