search

schteppe / p2.js

JavaScript 2D physics library
Other
2.64k stars 330 forks source link

Improve docs for applyForce and applyImpulse on Body #206

Closed evilstreak closed 8 years ago

evilstreak commented 8 years ago

I was trying to work out how I could use p2 to apply off-centre thrust to a body and the docs got me into a bit of a spin.

I dug into the code and I think these changes bring the docs inline with the actual behaviour. If not, I've definitely misunderstood things!

I can squash these commits down or split them out a little bit more (e9b297a is really 4 changes, but it seemed over the top to have it as four commits) – is there a style you prefer for contributions?

I couldn't find a way to build the docs; running grunt builds all the JS files but not the doc files. Since the built JS files contain a lot of changes that aren't the ones I've made, I'm assuming you handle the build and commit as a separate step when you want to cut a release, and that the doc build will be part of that. If that's not the case, please let me know.

jtenner commented 8 years ago

off-centre thrust to a body and the docs got me into a bit of a spin

pfft

schteppe commented 8 years ago

Looks like the docs were a bit off and that you understood the intended behavior well! I prefer contributions before no contributions, heh.

To build the docs you run yuidoc in the root. Should probably add some more docs about this, and/or add it to the Gruntfile.

Right now the "release commit" contains built docs and libs (the build/ dir), as well as the updated package.json. So you got it right! Should probably add this to the README.

Thanks a bunch for the PR - this is quality stuff!