Talk:Bullet User Manual and API documentation

From Physics Simulation Wiki

The user manual is riddled with mistakes and is quite unprofessional. Someone should seriously review the manual and clean it up. This manual the first thing many people see in relation to bullet and it's important to make a good first impression.

Here are a few of the mistakes I found while reading the PDF version of the manual:

- pg 9 : use only small parts of a the library

 remove "a"

- pg 11 : Mass, positive for dynamics moving objects

 should be "dynamic"

- pg 12 : a =btScalar= is a posh word for a floating point number

 what the heck is a "posh word"?

- pg 12 : in order to allow to compile the library

 in order to allow compilation of the library

- pg 13 : you can choose between ... is used when ... can be used

 these lines do not agree

- pg 15 : executes the collision algorithm computing contact points

 add comma between "algorithm" and "computing"

- pg 17 : represent a convex triangle meshes

 number mismatch; remove "a"

- pg 17 : for static world environment

 consider adding an article such as "a"

- pg 18 : with different scaling values for each axis, can be used

 remove comma here, and the two in the following sentence

- pg 18 : allows to instantiate - pg 18 : margin for collision shapes, to improve

 remove comma

- pg 18 : It is best not to modify the default collision margin, and if you do use a positive value: zero margin might introduce problems.

 colon should be semicolon; run-on sentence.
 Rewrite to something like this: 
 "It is best not to modify the default collision margin. If you do,
 use a positive value; a zero margin might introduce problems.

- pg 18 : which is 4 centimeter

 which is 4 centimeters

- pg 18 : Dependent on which collision shapes, the margin has different meaning.

 Rewrite to:
 The margin has different meanings for different collision shapes.

- pg 18 : so a gap will occur, unless

 remove comma.

- Almost every use of commas in this manual is wrong. I won't bring it up again.

- pg 20 : register callbacks to that

- pg 21 : for even more fine grain control

 s/grain/grained

- pg 23 : s/rander/render

- pg 26 : s/Constraint/Constraints

- pg 27 :

 the text claims that the slider constraint allows rotation but the
 picture does not suggest that the two cubes could rotate
 independently. Either the picture or the text is wrong.

- pg 29 : instead of simulation each wheel

 s/simulation/simulating

- pg 35 : Dynamica can simulation rigid body dynamica within

- pg 37 : s/centimeter/centimeters

- pg 37 : Better combine them.

 sentence fragment.

- pg 37 : Collision detection system

 insert article like "the"

- pg 38 : can better be avoided