Skip to content

docs: fix logger documentation #100

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.

Sign up for GitHub

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

Merged
busunkim96 merged 2 commits into from
Nov 20, 2020
Merged

docs: fix logger documentation #100

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
52a428c
docs: fix documentation for logger
busunkim96 Nov 19, 2020
2a762ed
chore: blacken
busunkim96 Nov 20, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
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
View file
Open in desktop
Original file line number Diff line number Diff line change
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