Add some documentation to our pamprovider module

1 files changed, 10 insertions, 0 deletions

diff --git a/funcweb/funcweb/identity/pamprovider.py b/funcweb/funcweb/identity/pamprovider.py
index ebcea91..68aedfb 100644
--- a/funcweb/funcweb/identity/pamprovider.py
+++ b/funcweb/funcweb/identity/pamprovider.py
@@ -17,6 +17,16 @@
 #
 # Author(s): Luke Macken <lmacken@redhat.com>
 
+"""
+This module contains an Identity Provider used by TurboGears to authenticate
+users against PAM.  It utilizes the pam.py module written by Chris AtLee.
+http://pypi.python.org/pypi/pam/0.1.2
+
+To utilize, simply define the following in your app.cfg:
+
+    identity.provider = 'pam'
+"""
+
 import pam
 import logging