diff --git a/car/util.py b/car/util.py index 5282fd4..e45ab26 100644 --- a/car/util.py +++ b/car/util.py @@ -1,2 +1,19 @@ +"""Car simulation utilities module + =============================== +""" + def mpsToKmph(speed): + """Meter per second to kilometer per hour unit converter + + Parameters + ---------- + speed : multiplicable (float, numpy.array etc.) + Speed in m/s + + Returns + ------- + as *speed* + Speed converted to km/h + + """ return speed*3.6 \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index e325ed6..9b48f37 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -9,6 +9,9 @@ Welcome to carSim's documentation! .. automodule:: car.motion :members: +.. automodule:: car.util + :members: + .. toctree:: :maxdepth: 2 :caption: Contents: