Changeset 706

Timestamp:

04/15/16 18:16:41 (8 years ago)

Author:

pinsard

Message:

rewrite one docstring for sphinx

File:

• trunk/src/useCorrTb_daily.py (modified) (1 diff, 1 prop)

trunk/src/useCorrTb_daily.py

@@ -157 +157 @@
 ##-----------------------------------------------------##
 def ms2time(ms):
-    """ ### Convert milliseconds in hour, minute, second
-    # Warning 1: lost millisecond because second is integer
-    # Warning 2: no day (but hour might be greater than 24)
-
-    ## Inputs
-    # ms  = millisecond
-    # 
-    ## Output
-    # h = hour
-    # m = minute
-    # s = second
-    #
+    """
+    Convert milliseconds in hour, minute, second
+
+    .. warning::
+
+       lost millisecond because second is integer
+
+    .. warning::
+
+       no day (but hour might be greater than 24)
+
+    :param ms: millisecond
+
+    :return: tuple (hour, minute, second)
+    :rtype: tuple
+
     >>> # one hour
     >>> ms = 1000 * 60 * 60