Added docstrings doc-dc
authorDamien Correia
Mon, 09 Apr 2018 17:05:53 +0200
branchdoc-dc
changeset 252 05af55de9eab
parent 164 07d7bca9e2af
child 253 146a0deffad8
Added docstrings
src/pyams_utils/__init__.py
src/pyams_utils/date.py
--- a/src/pyams_utils/__init__.py	Thu Apr 05 15:32:14 2018 +0200
+++ b/src/pyams_utils/__init__.py	Mon Apr 09 17:05:53 2018 +0200
@@ -9,7 +9,10 @@
 # WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
 # FOR A PARTICULAR PURPOSE.
 #
-
+"""
+PyAMS utilities
+===============
+"""
 __docformat__ = 'restructuredtext'
 
 
--- a/src/pyams_utils/date.py	Thu Apr 05 15:32:14 2018 +0200
+++ b/src/pyams_utils/date.py	Mon Apr 09 17:05:53 2018 +0200
@@ -28,10 +28,10 @@
 
 def unidate(value):
     """Get specified date converted to unicode ISO format
-    
+
     Dates are always assumed to be stored in GMT timezone
-    
-    :param date value: input date to convert to unicode
+
+    :param datetime value: input date to convert to unicode
     :return: unicode; input date converted to unicode
 
     >>> from datetime import datetime
@@ -48,9 +48,9 @@
 
 def parse_date(value):
     """Get date specified in unicode ISO format to Python datetime object
-    
+
     Dates are always assumed to be stored in GMT timezone
-    
+
     :param str value: unicode date to be parsed
     :return: datetime; the specified value, converted to datetime
 
@@ -65,7 +65,7 @@
 
 def date_to_datetime(value):
     """Get datetime value converted from a date or datetime object
-    
+
     :param date/datetime value: a date or datetime value to convert
     :return: datetime; input value converted to datetime