Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clean up docstring copy-pasta. #1666

Merged
merged 1 commit into from
Mar 28, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion gcloud/logging/_helpers.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ def logger_name_from_path(path, project):
included for validation purposes.

:rtype: string
:returns: Topic name parsed from ``path``.
:returns: Logger name parsed from ``path``.
:raises: :class:`ValueError` if the ``path`` is ill-formed or if
the project from the ``path`` does not agree with the
``project`` passed in.
Expand Down
12 changes: 6 additions & 6 deletions gcloud/logging/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -103,18 +103,18 @@ def list_entries(self, projects=None, filter_=None, order_by=None,
:data:`gcloud.logging.DESCENDING`.

:type page_size: int
:param page_size: maximum number of topics to return, If not passed,
:param page_size: maximum number of entries to return, If not passed,
defaults to a value set by the API.

:type page_token: string
:param page_token: opaque marker for the next "page" of topics. If not
:param page_token: opaque marker for the next "page" of entries. If not
passed, the API will return the first page of
topics.
entries.

:rtype: tuple, (list, str)
:returns: list of :class:`gcloud.logging.entry.TextEntry`, plus a
"next page token" string: if not None, indicates that
more topics can be retrieved with another call (pass that
more entries can be retrieved with another call (pass that
value as ``page_token``).
"""
if projects is None:
Expand Down Expand Up @@ -155,7 +155,7 @@ def sink(self, name, filter_, destination):
:param destination: destination URI for the entries exported by
the sink.

:rtype: :class:`gcloud.pubsub.sink.Sink`
:rtype: :class:`gcloud.logging.sink.Sink`
:returns: Sink created with the current client.
"""
return Sink(name, filter_, destination, client=self)
Expand Down Expand Up @@ -209,7 +209,7 @@ def metric(self, name, filter_, description=''):
:type description: string
:param description: the description of the metric to be constructed.

:rtype: :class:`gcloud.pubsub.metric.Metric`
:rtype: :class:`gcloud.logging.metric.Metric`
:returns: Metric created with the current client.
"""
return Metric(name, filter_, client=self, description=description)
Expand Down
14 changes: 7 additions & 7 deletions gcloud/logging/logger.py
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ def _require_client(self, client):

:type client: :class:`gcloud.logging.client.Client` or ``NoneType``
:param client: the client to use. If not passed, falls back to the
``client`` stored on the current topic.
``client`` stored on the current logger.

:rtype: :class:`gcloud.logging.client.Client`
:returns: The client passed in or the currently bound client.
Expand Down Expand Up @@ -152,9 +152,9 @@ def delete(self, client=None):
"""API call: delete all entries in a logger via a DELETE request

See:
https://cloud.google.com/pubsub/reference/rest/v1/projects.topics/delete
https://cloud.google.com/logging/docs/api/ref_v2beta1/rest/v2beta1/projects.logs/delete

:type client: :class:`gcloud.pubsub.client.Client` or ``NoneType``
:type client: :class:`gcloud.logging.client.Client` or ``NoneType``
:param client: the client to use. If not passed, falls back to the
``client`` stored on the current logger.
"""
Expand Down Expand Up @@ -182,18 +182,18 @@ def list_entries(self, projects=None, filter_=None, order_by=None,
:data:`gcloud.logging.DESCENDING`.

:type page_size: int
:param page_size: maximum number of topics to return, If not passed,
:param page_size: maximum number of entries to return, If not passed,
defaults to a value set by the API.

:type page_token: string
:param page_token: opaque marker for the next "page" of topics. If not
:param page_token: opaque marker for the next "page" of entries. If not
passed, the API will return the first page of
topics.
entries.

:rtype: tuple, (list, str)
:returns: list of :class:`gcloud.logging.entry.TextEntry`, plus a
"next page token" string: if not None, indicates that
more topics can be retrieved with another call (pass that
more entries can be retrieved with another call (pass that
value as ``page_token``).
"""
log_filter = 'logName:%s' % (self.name,)
Expand Down
2 changes: 1 addition & 1 deletion gcloud/logging/metric.py
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ def from_api_repr(cls, resource, client):
:type resource: dict
:param resource: metric resource representation returned from the API

:type client: :class:`gcloud.pubsub.client.Client`
:type client: :class:`gcloud.logging.client.Client`
:param client: Client which holds credentials and project
configuration for the metric.

Expand Down
2 changes: 1 addition & 1 deletion gcloud/logging/sink.py
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ def from_api_repr(cls, resource, client):
:type resource: dict
:param resource: sink resource representation returned from the API

:type client: :class:`gcloud.pubsub.client.Client`
:type client: :class:`gcloud.logging.client.Client`
:param client: Client which holds credentials and project
configuration for the sink.

Expand Down