Skip to content

Commit 6a46b46

Browse files
authored
docs: fix logger documentation (#100)
* docs: fix documentation for logger * chore: blacken
1 parent 4e24b3c commit 6a46b46

File tree

2 files changed

+9
-8
lines changed

2 files changed

+9
-8
lines changed

docs/conf.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -345,10 +345,10 @@
345345

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

google/cloud/logging_v2/logger.py

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -43,12 +43,13 @@
4343

4444

4545
class Logger(object):
46-
def __init__(self, name, client, *, labels=None):
47-
"""Loggers represent named targets for log entries.
46+
"""Loggers represent named targets for log entries.
4847
49-
See
50-
https://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.logs
48+
See https://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.logs
49+
"""
5150

51+
def __init__(self, name, client, *, labels=None):
52+
"""
5253
Args:
5354
name (str): The name of the logger.
5455
client (~logging_v2.client.Client):
@@ -57,7 +58,6 @@ def __init__(self, name, client, *, labels=None):
5758
labels (Optional[dict]): Mapping of default labels for entries written
5859
via this logger.
5960
60-
6161
"""
6262
self.name = name
6363
self._client = client
@@ -247,6 +247,7 @@ def list_entries(
247247
"organizations/[ORGANIZATION_ID]"
248248
"billingAccounts/[BILLING_ACCOUNT_ID]"
249249
"folders/[FOLDER_ID]"
250+
250251
If not passed, defaults to the project bound to the client.
251252
filter_ (Optional[str]): a filter expression. See
252253
https://cloud.google.com/logging/docs/view/advanced_filters

0 commit comments

Comments
 (0)