masfaraud / BMSpy

Python Block-Model Simulator. An alternative to simulink in python.
GNU Lesser General Public License v3.0
222 stars 36 forks source link

Documentation changes #17

Closed ericonr closed 5 years ago

ericonr commented 5 years ago

Hey there! It's me again!

So, I've taken a look at ways to make the documentation look better on code and generated. So I've added formulas and stuff, so the math is rendered prettily, and used google syntax for the parameters and returns, making it easier to both write and understand what's on the code, but not affecting the generated result.

I made a mess of the git side of things this time, so I think squashing this commit would be ideal, but I'm not a 100% sure.