Doc update

kubasaw · Oct 7, 2019 · 97b449a · 97b449a
1 parent b5687c4
commit 97b449a
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git 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
diff --git 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: