Merge pull request #321 from tseaver/159-document_exceptions_for_bucket_delete

tseaver · tseaver · commit 8e12e103c311 · 2014-10-31T14:44:17.000-04:00
Fix #159: Document exceptions (currently) raised from 'Bucket.delete'.
diff --git a/gcloud/storage/bucket.py b/gcloud/storage/bucket.py
@@ -144,7 +144,10 @@ def delete(self, force=False):
         :type force: bool
         :param full: If True, empties the bucket's objects then deletes it.
 
-        :raises: :class:`gcloud.storage.exceptions.NotFoundError`
+        :raises: :class:`gcloud.storage.exceptions.NotFoundError` if the
+                 bucket does not exist, or
+                 :class:`gcloud.storage.exceptions.ConnectionError` if the
+                 bucket has keys and `force` is not passed.
         """
         return self.connection.delete_bucket(self.name, force=force)
 
diff --git a/gcloud/storage/connection.py b/gcloud/storage/connection.py
@@ -380,7 +380,10 @@ def delete_bucket(self, bucket, force=False):
 
         :rtype: bool
         :returns: True if the bucket was deleted.
-        :raises: :class:`gcloud.storage.exceptions.NotFoundError`
+        :raises: :class:`gcloud.storage.exceptions.NotFoundError` if the
+                 bucket doesn't exist, or
+                 :class:`gcloud.storage.exceptions.ConnectionError` if the
+                 bucket has keys and `force` is not passed.
         """
         bucket = self.new_bucket(bucket)
 
