add docstrings

Author: bharathgs

pydateparser/__init__.py

@@ -1,3 +1,4 @@
 __version__ = '0.2.1'
 
 from .date_parser import DateParser
+from .date_formats import DateFormats

pydateparser/date_formats.py

@@ -1,5 +1,13 @@
+""""
+Defines various supported locale/types
+"""
+
+
 class DateFormats:
-    locale = {'USA':[
+    '''
+    standard dateformats, according to the various locales.
+    '''
+    locale = {'USA': [
         '%b %d %Y',
         '%b %-d %Y',
         '%b %d, %Y',
@@ -13,7 +21,7 @@ class DateFormats:
         '%m/%d/%y',
         '%m/%-d/%y'
     ],
-    'EU':[
+        'EU': [
         '%b %d %Y',
         '%b %-d %Y',
         '%b %d, %Y',

pydateparser/date_parser.py

@@ -1,3 +1,7 @@
+""""
+Date Parser Adapter.
+"""
+
 import attr
 from ._loggers import logger
 from collections import namedtuple
@@ -11,6 +15,26 @@
 class DateParser:
     """
     CoreDateParser Adapter class.
+
+    Parameters: 
+    ----------
+
+    text: str
+        a string/text document from which we can extract dates.
+
+    start_year: int
+        define the start year from which to look for the date.
+
+    end_year: int
+        define the end year from which to look for the date.
+
+    locale: None, str, list
+        define the type of dateformat(currently supports 'USA', 'EU'), default is None.
+        or pass your own list of patterns.
+
+    Returns: 
+    -------
+        list of `DATE` objects.
     """
     text = attr.ib(validator=attr.validators.instance_of(str))
     start_year = attr.ib(validator=attr.validators.instance_of(int))