summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMitch Garnaat <mitch@cloudright.com>2010-09-17 18:56:33 -0400
committerMitch Garnaat <mitch@cloudright.com>2010-09-17 18:56:33 -0400
commit9a1467da97d9c62506cd7b764cefd5eb62f6fb1a (patch)
tree782720e1dfa5e4708f8ef19a5918549414c11929
parentcc14c63d76c82663469315afc6e481a2b116c436 (diff)
downloadboto-9a1467da97d9c62506cd7b764cefd5eb62f6fb1a.tar.gz
More tedious clean up of docstring issues. Oh, sphinx, you are so needy.
-rw-r--r--boto/sdb/connection.py22
-rw-r--r--docs/source/ref/index.rst1
-rw-r--r--docs/source/ref/mapreduce.rst38
3 files changed, 13 insertions, 48 deletions
diff --git a/boto/sdb/connection.py b/boto/sdb/connection.py
index 0824f5cb..7710cc0f 100644
--- a/boto/sdb/connection.py
+++ b/boto/sdb/connection.py
@@ -248,16 +248,16 @@ class SDBConnection(AWSQueryConnection):
replace=True, expected_value=None):
"""
Store attributes for a given item in a domain.
-
+
:type domain_or_name: string or :class:`boto.sdb.domain.Domain` object.
:param domain_or_name: Either the name of a domain or a Domain object
-
+
:type item_name: string
:param item_name: The name of the item whose attributes are being stored.
-
+
:type attribute_names: dict or dict-like object
:param attribute_names: The name/value pairs to store as attributes
-
+
:type expected_value: list
:param expected_value: If supplied, this is a list or tuple consisting
of a single attribute name and expected value.
@@ -272,12 +272,12 @@ class SDBConnection(AWSQueryConnection):
* ['name', True|False]
which will simply check for the existence (True)
or non-existencve (False) of the attribute.
-
+
:type replace: bool
:param replace: Whether the attribute values passed in will replace
existing values or will be added as addition values.
Defaults to True.
-
+
:rtype: bool
:return: True if successful
"""
@@ -292,7 +292,7 @@ class SDBConnection(AWSQueryConnection):
def batch_put_attributes(self, domain_or_name, items, replace=True):
"""
Store attributes for multiple items in a domain.
-
+
:type domain_or_name: string or :class:`boto.sdb.domain.Domain` object.
:param domain_or_name: Either the name of a domain or a Domain object
@@ -302,12 +302,12 @@ class SDBConnection(AWSQueryConnection):
of attribute names/values, exactly the same as the
attribute_names parameter of the scalar put_attributes
call.
-
+
:type replace: bool
:param replace: Whether the attribute values passed in will replace
existing values or will be added as addition values.
Defaults to True.
-
+
:rtype: bool
:return: True if successful
"""
@@ -381,14 +381,18 @@ class SDBConnection(AWSQueryConnection):
:param expected_value: If supplied, this is a list or tuple consisting
of a single attribute name and expected value.
The list can be of the form:
+
* ['name', 'value']
+
In which case the call will first verify
that the attribute "name" of this item has
a value of "value". If it does, the delete
will proceed, otherwise a ConditionalCheckFailed
error will be returned.
The list can also be of the form:
+
* ['name', True|False]
+
which will simply check for the existence (True)
or non-existencve (False) of the attribute.
diff --git a/docs/source/ref/index.rst b/docs/source/ref/index.rst
index 0530ebac..764d8510 100644
--- a/docs/source/ref/index.rst
+++ b/docs/source/ref/index.rst
@@ -13,7 +13,6 @@ API Reference
ec2
fps
manage
- mapreduce
mashups
mturk
pyami
diff --git a/docs/source/ref/mapreduce.rst b/docs/source/ref/mapreduce.rst
deleted file mode 100644
index 97aa56cc..00000000
--- a/docs/source/ref/mapreduce.rst
+++ /dev/null
@@ -1,38 +0,0 @@
-.. ref-mapreduce
-
-=========
-mapreduce
-=========
-
-.. note::
-
- I am not sure why pdb_delete, pdb_revert, pdb_describe, and pdb_upload are not available for import.
-
-
-boto.mapreduce
---------------
-
-.. automodule:: boto.mapreduce
- :members:
- :undoc-members:
-
-boto.mapreduce.lqs
-------------------
-
-.. automodule:: boto.mapreduce.lqs
- :members:
- :undoc-members:
-
-boto.mapreduce.partitiondb
---------------------------
-
-.. automodule:: boto.mapreduce.partitiondb
- :members:
- :undoc-members:
-
-boto.mapreduce.queuetools
--------------------------
-
-.. automodule:: boto.mapreduce.queuetools
- :members:
- :undoc-members: