Add sphinx documentation generation

[ric-plt/lib/rmr.git] / src / bindings / rmr-python / rmr / rmr.py

diff --git a/src/bindings/rmr-python/rmr/rmr.py b/src/bindings/rmr-python/rmr/rmr.py
index aeb9e18..d1326c0 100644 (file)
--- a/src/bindings/rmr-python/rmr/rmr.py
+++ b/src/bindings/rmr-python/rmr/rmr.py
@@ -83,7 +83,17 @@ def _get_mapping_dict(cache={}):
 
 def _state_to_status(stateno):
     """
-    convery a msg state to status
+    Convert a msg state to status
+
+    Parameters
+    ----------
+    stateno: int
+        the state of the rmr message buffer
+
+    Returns
+    -------
+    string
+        the cooresponding message state
     """
     sdict = _get_mapping_dict()
     return sdict.get(stateno, "UNKNOWN STATE")