Skip to content

Clean up a documentation for the storage blob module.#3376

Merged
dhermes merged 1 commit intogoogleapis:masterfrom
dhermes:storage-blob-docs-update
May 16, 2017
Merged

Clean up a documentation for the storage blob module.#3376
dhermes merged 1 commit intogoogleapis:masterfrom
dhermes:storage-blob-docs-update

Conversation

@dhermes
Copy link
Contributor

@dhermes dhermes commented May 5, 2017

Many of the links were formatted incorrectly, etc.

NOTE: These changes were in #3375 but I've moved them here.

@dhermes
Clean up a documentation for the storage blob module.
ffe8bb2 
Many of the links were formatted incorrectly, etc.
@dhermes dhermes added api: storage Issues related to the Cloud Storage API. docs labels May 5, 2017
@googlebot googlebot added the cla: yes This human has signed the Contributor License Agreement. label May 5, 2017
@dhermes
Copy link
Contributor Author

dhermes commented May 9, 2017

@tseaver @lukesneeringer Can I get a review here?

tseaver
tseaver reviewed May 9, 2017
View reviewed changes
storage/google/cloud/storage/blob.py

.. _object versioning: https://cloud.google.com/storage/\
docs/object-versioning
.. _lifecycle: https://cloud.google.com/storage/docs/lifecycle

This comment was marked as spam.

Sign in to view

storage/google/cloud/storage/blob.py

:rtype: str or ``NoneType``

.. _RFC 7234: https://tools.ietf.org/html/rfc7234#section-5.2

This comment was marked as spam.

Sign in to view

storage/google/cloud/storage/blob.py

:rtype: str or ``NoneType``

.. _RFC 6266: https://tools.ietf.org/html/rfc7234#section-5.2

This comment was marked as spam.

Sign in to view

storage/google/cloud/storage/blob.py

:rtype: str or ``NoneType``

.. _RFC 7231: https://tools.ietf.org/html/rfc7231#section-3.1.2.2

This comment was marked as spam.

Sign in to view

storage/google/cloud/storage/blob.py

:rtype: str or ``NoneType``

.. _BCP47: https://tools.ietf.org/html/bcp47

This comment was marked as spam.

Sign in to view

storage/google/cloud/storage/blob.py

:rtype: str or ``NoneType``

.. _RFC 2616: https://tools.ietf.org/html/rfc2616#section-14.17

This comment was marked as spam.

Sign in to view

storage/google/cloud/storage/blob.py

:rtype: str or ``NoneType``

.. _RFC 4960: https://tools.ietf.org/html/rfc4960#appendix-B

This comment was marked as spam.

Sign in to view

storage/google/cloud/storage/blob.py
:rtype: str or ``NoneType``
:returns: The blob etag or ``None`` if the property is not set locally.

.. _RFC 2616 (etags): https://tools.ietf.org/html/rfc2616#section-3.11

This comment was marked as spam.

Sign in to view

storage/google/cloud/storage/blob.py

:rtype: str or ``NoneType``

.. _RFC 1321: https://tools.ietf.org/html/rfc1321

This comment was marked as spam.

Sign in to view

@dhermes
Copy link
Contributor Author

dhermes commented May 9, 2017

Would it make sense to put these in the module-scope docstring as well?

@tseaver I only did this for links which are used more than once.

@dhermes dhermes merged commit b807a00 into googleapis:master May 16, 2017
@dhermes dhermes deleted the storage-blob-docs-update branch May 16, 2017 16:31
This was referenced Jun 26, 2017
Closed
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

2 more reviewers

@lukesneeringer lukesneeringer lukesneeringer approved these changes

@tseaver tseaver tseaver approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@lukesneeringer lukesneeringer

@tseaver tseaver

Labels

api: storage Issues related to the Cloud Storage API. cla: yes This human has signed the Contributor License Agreement.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@dhermes @lukesneeringer @tseaver @googlebot