Documented core.py functions.

JNRowe · JNRowe · commit e9c0e9a99e8f · 2011-04-12T11:19:34.000+01:00
diff --git a/github2/core.py b/github2/core.py
@@ -7,21 +7,37 @@
 
 
 def ghdate_to_datetime(github_date):
+    """Convert Github date string to Python datetime
+
+    :param str github_date: date string to parse
+    """
     date_without_tz = " ".join(github_date.strip().split()[:2])
     return datetime.strptime(date_without_tz, GITHUB_DATE_FORMAT)
 
 
 def datetime_to_ghdate(datetime_):
+    """Convert Python datetime to Github date string
+
+    :param str datetime_: datetime object to convert
+    """
     date_without_tz = datetime_.strftime(GITHUB_DATE_FORMAT)
     return " ".join([date_without_tz, GITHUB_TIMEZONE])
 
 
 def commitdate_to_datetime(commit_date):
+    """Convert commit date string to Python datetime
+
+    :param str github_date: date string to parse
+    """
     date_without_tz = commit_date[:-6]
     return datetime.strptime(date_without_tz, COMMIT_DATE_FORMAT)
 
 
 def datetime_to_commitdate(datetime_):
+    """Convert Python datetime to Github date string
+
+    :param str datetime_: datetime object to convert
+    """
     date_without_tz = datetime_.strftime(COMMIT_DATE_FORMAT)
     return "".join([date_without_tz, GITHUB_TIMEZONE])
 
@@ -67,6 +83,11 @@ def get_values(self, *args, **kwargs):
 
 
 def doc_generator(docstring, attributes):
+    """Utility function to augment BaseDataType docstring
+
+    :param str docstring: docstring to augment
+    :param dict attributes: attributes to add to docstring
+    """
     docstring = docstring or ""
 
     def section(title):
