Document all CFMap.*get*() parameters

Fixes #56
pycassa · Apr 11, 2011 · c9f99cf · c9f99cf
1 parent fb001fe
commit c9f99cf
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 6 deletions.
diff --git a/doc/api/pycassa/columnfamilymap.rst b/doc/api/pycassa/columnfamilymap.rst
@@ -5,15 +5,15 @@
 
     .. autoclass:: pycassa.columnfamilymap.ColumnFamilyMap(cls, column_family[, columns][, raw_columns])
 
-        .. automethod:: get(key[, columns][, super_column][, read_consistency_level])
+        .. automethod:: get(key[, columns][, column_start][, column_finish][, column_count][, column_reversed][, super_column][, read_consistency_level])
 
-        .. automethod:: multiget(keys[, columns][, super_column][, read_consistency_level])
+        .. automethod:: multiget(keys[, columns][, column_start][, column_finish][, column_count][, column_reversed][, super_column][, read_consistency_level])
 
         .. automethod:: get_count(key[, columns][, super_column][, read_consistency_level])
 
-        .. automethod:: get_range([start][, finish][, row_count][, columns][, super_column][, read_consistency_level][, buffer_size])
+        .. automethod:: get_range([start][, finish][, columns][, column_start][, column_finish][, column_reversed][, column_count][, row_count][, super_column][, read_consistency_level][, buffer_size])
 
-        .. automethod:: get_indexed_slices(index_clause[,instance][, columns][, super_column][, read_consistency_level][, buffer_size])
+        .. automethod:: get_indexed_slices(index_clause[, columns][, column_start][, column_finish][, column_reversed][, column_count][, include_timestamp][, read_consistency_level][, buffer_size])
 
         .. automethod:: insert(instance[, columns][, write_consistency_level])
 

diff --git a/pycassa/columnfamilymap.py b/pycassa/columnfamilymap.py
@@ -42,7 +42,7 @@ def __init__(self, cls, column_family, columns=None, raw_columns=False):
         Instances of `cls` are returned from :meth:`get()`, :meth:`multiget()`,
         :meth:`get_range()` and :meth:`get_indexed_slices()`.
 
-        `column_family` is a :class:`~pycassa.columnfamily.ColumnFamily` to
+        `column_family` is a :class:`~.ColumnFamily` to
         tie with `cls`.  This :class:`ColumnFamily` should almost always have
         `autopack_names` and `autopack_values` set to ``False``.
 
@@ -92,6 +92,8 @@ def get(self, key, *args, **kwargs):
         one instance of `cls` will be returned; if `columns` is specified
         in this case, only those attributes listed in `columns` will be fetched.
 
+        All other parameters behave the same as in :meth:`.ColumnFamily.get()`.
+
         """
         if 'columns' not in kwargs and not self.column_family.super and not self.raw_columns:
             kwargs['columns'] = self.columns.keys()
@@ -166,7 +168,7 @@ def get_range(self, *args, **kwargs):
         column family depends on what parameters are passed.
 
         For an explanation of how :meth:`get_range` works and a description
-        of the parameters, see :meth:`pycassa.columnfamily.ColumnFamily.get_range()`.
+        of the parameters, see :meth:`.ColumnFamily.get_range()`.
 
         Example usage with a standard column family: