diff options
| author | Mitch Garnaat <mitch@cloudright.com> | 2010-09-17 22:56:27 -0400 |
|---|---|---|
| committer | Mitch Garnaat <mitch@cloudright.com> | 2010-09-17 22:56:27 -0400 |
| commit | cf1412234779046de156e3fbbc97458ce7fcb5e5 (patch) | |
| tree | ee0f5f9dc43abb377457e2f193d53839a928f8cd | |
| parent | 9a1467da97d9c62506cd7b764cefd5eb62f6fb1a (diff) | |
| download | boto-cf1412234779046de156e3fbbc97458ce7fcb5e5.tar.gz | |
More tweaks to the docstrings to try to appease the sphinx.cleandocs
| -rw-r--r-- | boto/sdb/connection.py | 12 | ||||
| -rw-r--r-- | boto/sns/__init__.py | 1 | ||||
| -rwxr-xr-x | boto/storage_uri.py | 4 | ||||
| -rw-r--r-- | docs/source/ref/iam.rst | 2 |
4 files changed, 12 insertions, 7 deletions
diff --git a/boto/sdb/connection.py b/boto/sdb/connection.py index 7710cc0f..8efebcde 100644 --- a/boto/sdb/connection.py +++ b/boto/sdb/connection.py @@ -262,14 +262,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'] + + * ['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 @@ class SDBConnection(AWSQueryConnection): 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 @@ class SDBConnection(AWSQueryConnection): 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. diff --git a/boto/sns/__init__.py b/boto/sns/__init__.py index 3f9a379d..79fc92d9 100644 --- a/boto/sns/__init__.py +++ b/boto/sns/__init__.py @@ -259,6 +259,7 @@ class SNSConnection(AWSQueryConnection): 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 diff --git a/boto/storage_uri.py b/boto/storage_uri.py index 66ad572f..13d757b1 100755 --- a/boto/storage_uri.py +++ b/boto/storage_uri.py @@ -27,8 +27,8 @@ from boto.exception import InvalidUriError 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). """ diff --git a/docs/source/ref/iam.rst b/docs/source/ref/iam.rst index b10a0dbb..ace61701 100644 --- a/docs/source/ref/iam.rst +++ b/docs/source/ref/iam.rst @@ -12,7 +12,7 @@ boto.iam :undoc-members: boto.iam.response ----------------- +----------------- .. automodule:: boto.iam.response :members: |