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

Bodies.trapezoid slope documentation not detailed enough #1075

Closed
ZufengW opened this issue Jan 3, 2022 · 0 comments
Closed

Bodies.trapezoid slope documentation not detailed enough #1075

ZufengW opened this issue Jan 3, 2022 · 0 comments

Comments

@ZufengW
Copy link

ZufengW commented Jan 3, 2022

I was trying to use Bodies.trapezoid, but got confused because my trapezoids looked strange. Turns out this was because I was using slope values >= 1. I only figured out I should be using values < 1 by reading #138 (comment)

This expected value range should be added to the documentation. Maybe also add a warning if the user provides invalid trapezoid dimensions.

Doc link: https://brm.io/matter-js/docs/classes/Bodies.html#method_trapezoid

Some examples could also help. The "Examples" link in the doc currently shows no results.

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

2 participants