Skip to content

Commit

Permalink
Documenting dunder (e.g. __iter__) methods without docstrings.
Browse files Browse the repository at this point in the history
  • Loading branch information
dhermes committed Feb 10, 2015
1 parent a6317d1 commit ad9e30c
Showing 1 changed file with 20 additions and 1 deletion.
21 changes: 20 additions & 1 deletion gcloud/storage/bucket.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,26 @@
# See the License for the specific language governing permissions and
# limitations under the License.

"""Create / interact with gcloud storage buckets."""
"""Create / interact with gcloud storage buckets.
If you want to check whether a blob exists, you can use the ``in`` operator
in Python::
>>> print 'kitten.jpg' in bucket
True
>>> print 'does-not-exist' in bucket
False
If you want to get all the blobs in the bucket, you can use
:func:`get_all_blobs <gcloud.storage.bucket.Bucket.get_all_blobs>`::
>>> blobs = bucket.get_all_blobs()
You can also use the bucket as an iterator::
>>> for blob in bucket:
... print blob
"""

import os
import six
Expand Down

0 comments on commit ad9e30c

Please sign in to comment.