From 124dc1b969f584ed9e58a172bea4953c293d8a0b Mon Sep 17 00:00:00 2001
From: Mike Helmick <mikehelmick@me.com>
Date: Fri, 7 Jun 2013 20:54:23 -0400
Subject: [PATCH] File coding, file description ALL THE THINGS

[ci skip]
---
 twython/advisory.py        | 16 ++++++++++++++++
 twython/compat.py          | 10 ++++++++++
 twython/exceptions.py      |  9 +++++++++
 twython/helpers.py         | 10 ++++++++++
 twython/streaming/api.py   | 10 ++++++++++
 twython/streaming/types.py |  2 +-
 6 files changed, 56 insertions(+), 1 deletion(-)

diff --git a/twython/advisory.py b/twython/advisory.py
index edff80e..f553f31 100644
--- a/twython/advisory.py
+++ b/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
diff --git a/twython/compat.py b/twython/compat.py
index 26af6e8..da8443b 100644
--- a/twython/compat.py
+++ b/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
diff --git a/twython/exceptions.py b/twython/exceptions.py
index be418a2..cb8c077 100644
--- a/twython/exceptions.py
+++ b/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
 
 
diff --git a/twython/helpers.py b/twython/helpers.py
index b19d869..1d3b004 100644
--- a/twython/helpers.py
+++ b/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
 
 
diff --git a/twython/streaming/api.py b/twython/streaming/api.py
index 05eafdb..2496763 100644
--- a/twython/streaming/api.py
+++ b/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
diff --git a/twython/streaming/types.py b/twython/streaming/types.py
index e96adef..104f965 100644
--- a/twython/streaming/types.py
+++ b/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.
 """