A lot of final cleanups, deprecation normalized, etc.

Author: Sean Cribbs

docs/advanced.rst

@@ -19,8 +19,6 @@ Connection pool
    :members:
 
 .. autoclass:: PoolIterator
-   :members:
-   :special-members:
 
 -----------
 Retry logic

docs/client.rst

@@ -147,7 +147,9 @@ Deprecated Methods
 .. attribute:: RiakClient.solr
 
    Returns a RiakSearch object which can access search indexes.
-   **DEPRECATED**
+
+   .. deprecated:: 2.0.0
+      Use the ``fulltext_*`` methods instead.
 
 .. automethod:: RiakClient.get_r
 .. automethod:: RiakClient.set_r

docs/object.rst

@@ -1,6 +1,6 @@
-==============
-Keys & Objects
-==============
+================
+Values & Objects
+================
 
 .. currentmodule:: riak.riak_object
 

docs/query.rst

@@ -26,12 +26,12 @@ for equality or across ranges.::
 
     # Performs an equality query
     seans = bucket.get_index("fname_bin", "Sean")
-    
+
     # Performs a range query
     eighties = bucket.get_index("byear_int", 1980, 1989)
 
 Secondary indexes are also available via :meth:`MapReduce
-<riak.mapreduce.MapReduce.index>`.
+<riak.mapreduce.RiakMapReduce.index>`.
 
 ^^^^^^^^^^^^^^^^^^
 Riak 1.4+ Features
@@ -112,7 +112,7 @@ MapReduce
 
 .. currentmodule:: riak.mapreduce
 
-:class:`MapReduce` allows you to construct query-processing jobs that
+:class:`RiakMapReduce` allows you to construct query-processing jobs that
 are performed mostly in-parallel around the Riak cluster. You can
 think of it as a pipeline, where inputs are fed in one end, they pass
 through a number of ``map`` and ``reduce`` phases, and then are
@@ -163,7 +163,7 @@ results, while ``reduce`` phases operate over collections of results
 from previous phases. ``link`` phases are a special type of ``map``
 phase that extract matching :attr:`~riak.riak_object.RiakObject.links`
 from the object, usually so they can be used in a subsequent ``map``
-phase. 
+phase.
 
 Any number of phases can return results directly to the client by
 passing ``keep=True``.

riak/__init__.py

@@ -48,8 +48,9 @@ def __str__(self):
 
 class ConflictError(RiakError):
     """
-    Raised when an operation is attempted on a RiakObject that has
-    more than one sibling.
+    Raised when an operation is attempted on a
+    :class:`~riak.riak_object.RiakObject` that has more than one
+    sibling.
     """
     def __init__(self, message="Object in conflict"):
         super(ConflictError, self).__init__(message)

riak/bucket.py

@@ -170,7 +170,10 @@ def new_binary(self, key=None, data=None,
         Create a new :class:`RiakObject <riak.riak_object.RiakObject>`
         that will be stored as plain text/binary. A shortcut for
         manually instantiating a :class:`RiakObject
-        <riak.riak_object.RiakObject>`. **DEPRECATED**
+        <riak.riak_object.RiakObject>`.
+
+        .. deprecated:: 2.0.0
+           Use :meth:`new` instead.
 
         :param key: Name of the key.
         :type key: string
@@ -204,7 +207,10 @@ def get(self, key, r=None, pr=None, timeout=None):
 
     def get_binary(self, key, r=None, pr=None, timeout=None):
         """
-        Retrieve a binary/string object from Riak. **DEPRECATED**
+        Retrieve a binary/string object from Riak.
+
+        .. deprecated:: 2.0.0
+           Use :meth:`get` instead.
 
         :param key: Name of the key.
         :type key: string
@@ -393,7 +399,10 @@ def new_binary_from_file(self, key, filename):
         """
         Create a new Riak object in the bucket, using the contents of
         the specified file. This is a shortcut for :meth:`new`, where the
-        ``encoded_data`` and ``content_type`` are set for you. **DEPRECATED**
+        ``encoded_data`` and ``content_type`` are set for you.
+
+        .. deprecated:: 2.0.0
+           Use :meth:`new_from_file` instead.
 
         :param key: the key of the new object
         :type key: string

riak/client/__init__.py

@@ -138,16 +138,21 @@ def _set_protocol(self, value):
     def get_transport(self):
         """
         Get the transport instance the client is using for it's
-        connection. DEPRECATED
+        connection.
+
+        .. deprecated:: 2.0.0
+           There is no equivalent to this method, it will return ``None``.
         """
         deprecated("get_transport is deprecated, use client, " +
                    "bucket, or object methods instead")
         return None
 
     def get_client_id(self):
         """
-        Get the ``client_id`` for this ``RiakClient`` instance.
-        DEPRECATED
+        Get the client identifier.
+
+        .. deprecated:: 2.0.0
+           Use the :attr:`client_id` attribute instead.
 
         :rtype: string
         """
@@ -157,8 +162,10 @@ def get_client_id(self):
 
     def set_client_id(self, client_id):
         """
-        Set the client_id for this ``RiakClient`` instance.
-        DEPRECATED
+        Set the client identifier.
+
+        .. deprecated:: 2.0.0
+           Use the :attr:`client_id` attribute instead.
 
         :param client_id: The new client_id.
         :type client_id: string
@@ -243,7 +250,9 @@ def bucket(self, name):
     def solr(self):
         """
         Returns a RiakSearch object which can access search indexes.
-        DEPRECATED
+
+        .. deprecated:: 2.0.0
+           Use the ``fulltext_*`` methods instead.
         """
         deprecated("``solr`` is deprecated, use ``fulltext_search``,"
                    " ``fulltext_add`` and ``fulltext_delete`` directly")

riak/client/multiget.py

@@ -142,7 +142,8 @@ def _should_quit(self):
         input queue is empty. Once the stop flag is set, new enqueues
         are disallowed, meaning that the workers can safely drain the
         queue before exiting.
-        :rtype: boolean
+
+        :rtype: bool
         """
         return self.stopped() and self._inq.empty()
 

riak/mapreduce.py

@@ -605,7 +605,25 @@ def to_array(self):
 
 
 class RiakKeyFilter(object):
+    """
+    A helper class for building up lists of key filters. Unknown
+    methods are treated as filters to be added; ``&`` and ``|`` create
+    conjunctions and disjunctions, respectively. ``+`` concatenates filters.
+
+    Example::
+
+        f1 = RiakKeyFilter().starts_with('2005')
+        f2 = RiakKeyFilter().ends_with('-01')
+        f3 = f1 & f2
+        print f3
+        # => [['and', [['starts_with', '2005']], [['ends_with', '-01']]]]
+    """
+
     def __init__(self, *args):
+        """
+        :param args: a list of arguments to be treated as a filter.
+        :type args: list
+        """
         if args:
             self._filters = [list(args)]
         else:

riak/transports/transport.py

@@ -82,7 +82,6 @@ def delete(self, robj, rw=None, r=None, w=None, dw=None, pr=None,
                pw=None, timeout=None):
         """
         Deletes an object.
-        @return true
         """
         raise NotImplementedError