File coding, file description ALL THE THINGS

[ci skip]

twython/advisory.py

@@ -1,3 +1,19 @@
+# -*- coding: utf-8 -*-
+
+"""
+twython.advisory
+~~~~~~~~~~~~~~~~
+
+This module contains Warning classes for Twython to specifically
+alert the user about.
+
+This mainly is because Python 2.7 > mutes DeprecationWarning and when
+we deprecate a method or variable in Twython, we want to use to see
+the Warning but don't want ALL DeprecationWarnings to appear,
+only TwythonDeprecationWarnings.
+"""
+
+
 class TwythonDeprecationWarning(DeprecationWarning):
     """Custom DeprecationWarning to be raised when methods/variables are being deprecated in Twython.
     Python 2.7 > ignores DeprecationWarning so we want to specifcally bubble up ONLY Twython Deprecation Warnings

twython/compat.py

@@ -1,3 +1,13 @@
+# -*- coding: utf-8 -*-
+
+"""
+twython.compat
+~~~~~~~~~~~~~~
+
+This module contains imports and declarations for seamless Python 2 and
+Python 3 compatibility.
+"""
+
 import sys
 
 _ver = sys.version_info

twython/exceptions.py

@@ -1,3 +1,12 @@
+# -*- coding: utf-8 -*-
+
+"""
+twython.exceptions
+~~~~~~~~~~~~~~~~~~
+
+This module contains Twython specific Exception classes.
+"""
+
 from .endpoints import TWITTER_HTTP_STATUS_CODE
 
 

twython/helpers.py

@@ -1,3 +1,13 @@
+# -*- coding: utf-8 -*-
+
+"""
+twython.helpers
+~~~~~~~~~~~~~~~
+
+This module contains functions that are repeatedly used throughout
+the Twython library.
+"""
+
 from .compat import basestring, numeric_types
 
 

twython/streaming/api.py

@@ -1,3 +1,13 @@
+# -*- coding: utf-8 -*-
+
+"""
+twython.streaming.api
+~~~~~~~~~~~~~~~~~~~~~
+
+This module contains functionality for interfacing with streaming
+Twitter API calls.
+"""
+
 from .. import __version__
 from ..compat import json, is_py3
 from .types import TwythonStreamerTypes

twython/streaming/types.py

@@ -4,7 +4,7 @@
 twython.streaming.types
 ~~~~~~~~~~~~~~~~~~~~~~~
 
-This module contains classes and methods for :class:`TwythonStreamer` to mak
+This module contains classes and methods for :class:`TwythonStreamer` to use.
 """