Skip to content

Commit

Permalink
Updating some Sphinx class links.
Browse files Browse the repository at this point in the history
Follow-up to PR #2223. The Sphinx mechanism of using
a `.` to mean "go find this class" can be confusing,
so we make sure the `.` also is a relative path.
  • Loading branch information
dhermes committed Sep 7, 2016
1 parent 570cf29 commit d11baf2
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 11 deletions.
2 changes: 1 addition & 1 deletion google/cloud/datastore/batch.py
Original file line number Diff line number Diff line change
Expand Up @@ -290,7 +290,7 @@ def _assign_entity_to_pb(entity_pb, entity):
Helper method for ``Batch.put``.
:type entity_pb: :class:`.datastore._generated.entity_pb2.Entity`
:type entity_pb: :class:`._generated.entity_pb2.Entity`
:param entity_pb: The entity owned by a mutation.
:type entity: :class:`google.cloud.datastore.entity.Entity`
Expand Down
8 changes: 4 additions & 4 deletions google/cloud/datastore/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ def _extended_lookup(connection, project, key_pbs,
:type project: string
:param project: The project to make the request for.
:type key_pbs: list of :class:`.datastore._generated.entity_pb2.Key`
:type key_pbs: list of :class:`._generated.entity_pb2.Key`
:param key_pbs: The keys to retrieve from the datastore.
:type missing: list
Expand All @@ -100,7 +100,7 @@ def _extended_lookup(connection, project, key_pbs,
the given transaction. Incompatible with
``eventual==True``.
:rtype: list of :class:`.datastore._generated.entity_pb2.Entity`
:rtype: list of :class:`._generated.entity_pb2.Entity`
:returns: The requested entities.
:raises: :class:`ValueError` if missing / deferred are not null or
empty list.
Expand Down Expand Up @@ -245,7 +245,7 @@ def get(self, key, missing=None, deferred=None, transaction=None):
:param deferred: (Optional) If a list is passed, the keys returned
by the backend as "deferred" will be copied into it.
:type transaction: :class:`~.datastore.transaction.Transaction`
:type transaction: :class:`~.transaction.Transaction`
:param transaction: (Optional) Transaction to use for read consistency.
If not passed, uses current transaction, if set.
Expand Down Expand Up @@ -273,7 +273,7 @@ def get_multi(self, keys, missing=None, deferred=None, transaction=None):
by the backend as "deferred" will be copied into it.
If the list is not empty, an error will occur.
:type transaction: :class:`~.datastore.transaction.Transaction`
:type transaction: :class:`~.transaction.Transaction`
:param transaction: (Optional) Transaction to use for read consistency.
If not passed, uses current transaction, if set.
Expand Down
4 changes: 2 additions & 2 deletions google/cloud/streaming/exceptions.py
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ def status_code(self):
def from_response(cls, http_response):
"""Factory: construct an exception from a response.
:type http_response: :class:`~.streaming.http_wrapper.Response`
:type http_response: :class:`~.http_wrapper.Response`
:param http_response: the response which returned the error
:rtype: :class:`HttpError`
Expand Down Expand Up @@ -108,7 +108,7 @@ def __init__(self, response, content, url, retry_after):
def from_response(cls, http_response):
"""Factory: construct an exception from a response.
:type http_response: :class:`~.streaming.http_wrapper.Response`
:type http_response: :class:`~.http_wrapper.Response`
:param http_response: the response which returned the error.
:rtype: :class:`RetryAfterError`
Expand Down
7 changes: 3 additions & 4 deletions google/cloud/streaming/http_wrapper.py
Original file line number Diff line number Diff line change
Expand Up @@ -273,10 +273,9 @@ def _check_response(response):
:param response: the response to validate
:raises: :exc:`google.cloud.streaming.exceptions.RequestError` if response
is None, :exc:`~.streaming.exceptions.BadStatusCodeError` if
response status code indicates an error, or
:exc:`~.streaming.exceptions.RetryAfterError` if response
indicates a retry interval.
is None, :exc:`~.exceptions.BadStatusCodeError` if response status
code indicates an error, or :exc:`~.exceptions.RetryAfterError`
if response indicates a retry interval.
"""
if response is None:
# Caller shouldn't call us if the response is None, but handle anyway.
Expand Down

0 comments on commit d11baf2

Please sign in to comment.