Permalink
Browse files

More tweaks to the docstrings to try to appease the sphinx.

  • Loading branch information...
1 parent 9a1467d commit cf1412234779046de156e3fbbc97458ce7fcb5e5 Mitch Garnaat committed Sep 18, 2010
Showing with 12 additions and 7 deletions.
  1. +8 −4 boto/sdb/connection.py
  2. +1 −0 boto/sns/__init__.py
  3. +2 −2 boto/storage_uri.py
  4. +1 −1 docs/source/ref/iam.rst
View
@@ -262,14 +262,18 @@ def put_attributes(self, domain_or_name, item_name, attributes,
: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']
+
+ * ['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]
+
+ * ['name', True|False]
+
which will simply check for the existence (True)
or non-existencve (False) of the attribute.
@@ -382,7 +386,7 @@ def delete_attributes(self, domain_or_name, item_name, attr_names=None,
of a single attribute name and expected value.
The list can be of the form:
- * ['name', 'value']
+ * ['name', 'value']
In which case the call will first verify
that the attribute "name" of this item has
@@ -391,7 +395,7 @@ def delete_attributes(self, domain_or_name, item_name, attr_names=None,
error will be returned.
The list can also be of the form:
- * ['name', True|False]
+ * ['name', True|False]
which will simply check for the existence (True)
or non-existencve (False) of the attribute.
View
@@ -259,6 +259,7 @@ def subscribe_sqs_queue(self, topic, queue):
This is convenience method that handles most of the complexity involved
in using ans SQS queue as an endpoint for an SNS topic. To achieve this
the following operations are performed:
+
* The correct ARN is constructed for the SQS queue and that ARN is
then subscribed to the topic.
* A JSON policy document is contructed that grants permission to
View
@@ -27,8 +27,8 @@
class StorageUri(object):
"""
Base class for representing storage provider-independent bucket and
- object name with a shorthand URI-like syntax.
-
+ object name with a shorthand URI-like
+
This is an abstract class: the constructor cannot be called (throws an
exception if you try).
"""
View
@@ -12,7 +12,7 @@ boto.iam
:undoc-members:
boto.iam.response
-----------------
+-----------------
.. automodule:: boto.iam.response
:members:

0 comments on commit cf14122

Please sign in to comment.