Merge pull request #117 from tvincentNuoDB/master

Updated Python docstrings

Author: mjmichaels

README.rst

@@ -12,8 +12,8 @@ NuoDB - Python
 
 .. contents::
 
-This package contains the official pure-Python NuoDB_ client library that
-provides both a standard `PEP 249`_ SQL API, a NuoDB administration API.
+This package contains the community driven pure-Python NuoDB_ client library that
+provides both a standard `PEP 249`_ SQL API, a NuoDB administration API. This is a community driven driver with limited support and testing from NuoDB.
 
 Requirements
 ------------

pynuodb/crypt.py

@@ -305,7 +305,9 @@ def transform(self, data):
 class NoCipher(object):
 
     def __init__(self):
+        """ A class to allow polymorphic cipher streams"""
         pass
 
     def transform(self, data):
+        """ Returns the data as passed in so that it will be sent unencrypted to the server"""
         return data

pynuodb/cursor.py

@@ -40,16 +40,16 @@ class Cursor(object):
     def __init__(self, session, prepared_statement_cache_size):
         """
         Constructor for the Cursor class.
-        @type session EncodedSession
+        :type session EncodedSession
         """
         self.session = session
-        """ @type : EncodedSession """
+        """ :type : EncodedSession """
 
         self._statement_cache = StatementCache(session, prepared_statement_cache_size)
-        """ @type : StatementCache """
+        """ :type : StatementCache """
 
         self._result_set = None
-        """ @type : result_set.ResultSet """
+        """ :type : result_set.ResultSet """
 
         self.closed = False
         self.arraysize = 1
@@ -205,30 +205,30 @@ def setoutputsize(self, size, column=None):
 class StatementCache(object):
     def __init__(self, session, prepared_statement_cache_size):
         self._session = session
-        """ @type : EncodedSession """
+        """ :type : EncodedSession """
 
         self._statement = self._session.create_statement()
-        """ @type : Statement """
+        """ :type : Statement """
 
         self._ps_cache = dict()
-        """ @type : dict[str,PreparedStatement] """
+        """ :type : dict[str,PreparedStatement] """
 
         self._ps_key_queue = deque()
-        """ @type : deque[str] """
+        """ :type : deque[str] """
 
         self._ps_cache_size = prepared_statement_cache_size
-        """ @type : int """
+        """ :type : int """
 
     def get_statement(self):
         """
-        @rtype: Statement
+        :rtype : Statement
         """
         return self._statement
 
     def get_prepared_statement(self, query):
         """
-        @type query str
-        @rtype: PreparedStatement
+        :type query str
+        :rtype : PreparedStatement
         """
 
         statement = self._ps_cache.get(query)
@@ -251,6 +251,7 @@ def get_prepared_statement(self, query):
         return statement
 
     def shutdown(self):
+        """ Close connection and clear the cursor cache"""
         self._session.close_statement(self._statement)
 
         for key in self._ps_cache:
@@ -259,3 +260,4 @@ def shutdown(self):
 
         self._ps_cache.clear()
         self._ps_key_queue.clear()
+