sympy/sympy — pull request #1313 by moorepants (2012-05-26 02:55:09+00:00)
Title: Fixed RigidBody documentation and made the mass center attribute more clear.

The first commit can be cherry picked if the other two are unwanted.

1. The doc string for the RigidBody class had incorrectly ordered parameters, which gave confusion when using the doc string to figure out what parameters to pass to the __init__ method. This is related to question 1. below.

2. I changed .mc to .masscenter for more clarity.

I have three questions:

1. What is the standard for specifying a doc string to a class and it's __init__ method? If you use introspection with iPython (e.g. RigidBody?) and there is only a class doc string, you have less information for passing arguments to its constructor. Should the information that is now in the RigidBody doc string be put into the doc string of its __init__ method instead. It seems to me that it would be more useful that way. For example, why does Symbol? provide the function call and RigidBody? not?

2. What is the protocol for depreciation warnings? The second two commits change the api.

3. Should the get and set methods of RigidBody be private?