Skip to content

Commit

Permalink
docs: fix logger documentation (#100)
Browse files Browse the repository at this point in the history
* docs: fix documentation for logger

* chore: blacken
  • Loading branch information
busunkim96 committed Nov 20, 2020
1 parent 4e24b3c commit 6a46b46
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 8 deletions.
6 changes: 3 additions & 3 deletions docs/conf.py
Expand Up @@ -345,10 +345,10 @@

# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {
"python": ("http://python.readthedocs.org/en/latest/", None),
"google-auth": ("https://google-auth.readthedocs.io/en/stable", None),
"python": ("https://python.readthedocs.org/en/latest/", None),
"google-auth": ("https://googleapis.dev/python/google-auth/latest/", None),
"google.api_core": ("https://googleapis.dev/python/google-api-core/latest/", None,),
"grpc": ("https://grpc.io/grpc/python/", None),
"grpc": ("https://grpc.github.io/grpc/python/", None),
"proto-plus": ("https://proto-plus-python.readthedocs.io/en/latest/", None),
}

Expand Down
11 changes: 6 additions & 5 deletions google/cloud/logging_v2/logger.py
Expand Up @@ -43,12 +43,13 @@


class Logger(object):
def __init__(self, name, client, *, labels=None):
"""Loggers represent named targets for log entries.
"""Loggers represent named targets for log entries.
See
https://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.logs
See https://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.logs
"""

def __init__(self, name, client, *, labels=None):
"""
Args:
name (str): The name of the logger.
client (~logging_v2.client.Client):
Expand All @@ -57,7 +58,6 @@ def __init__(self, name, client, *, labels=None):
labels (Optional[dict]): Mapping of default labels for entries written
via this logger.
"""
self.name = name
self._client = client
Expand Down Expand Up @@ -247,6 +247,7 @@ def list_entries(
"organizations/[ORGANIZATION_ID]"
"billingAccounts/[BILLING_ACCOUNT_ID]"
"folders/[FOLDER_ID]"
If not passed, defaults to the project bound to the client.
filter_ (Optional[str]): a filter expression. See
https://cloud.google.com/logging/docs/view/advanced_filters
Expand Down

0 comments on commit 6a46b46

Please sign in to comment.