Skip to content

Commit 7723cb1

Browse files
committed
updates docstrings
1 parent 0e6c6e7 commit 7723cb1

File tree

2 files changed

+25
-16
lines changed

2 files changed

+25
-16
lines changed

google/cloud/bigquery/client.py

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -868,21 +868,20 @@ def get_dataset(
868868
The number of seconds to wait for the underlying HTTP transport
869869
before using ``retry``.
870870
dataset_view (Optional[google.cloud.bigquery.enums.DatasetView]):
871-
# TODO clean up this docstring.
872-
Specifies the level of detail to include for the dataset resource.
873-
If provided and not None, this parameter controls which parts of the
874-
dataset resource are returned.
875-
Possible enum values:
876-
- :attr:`~google.cloud.bigquery.enums.DatasetView.ACL`:
877-
Includes dataset metadata and the ACL.
878-
- :attr:`~google.cloud.bigquery.enums.DatasetView.FULL`:
879-
Includes all dataset metadata, including the ACL and table metadata.
880-
This view is not supported by the `datasets.list` API method.
881-
- :attr:`~google.cloud.bigquery.enums.DatasetView.METADATA`:
882-
Includes basic dataset metadata, but not the ACL.
883-
- :attr:`~google.cloud.bigquery.enums.DatasetView.DATASET_VIEW_UNSPECIFIED`:
884-
The server will decide which view to use.
885-
871+
Specifies the view that determines which dataset information is
872+
returned. By default, datase metadata (e.g. friendlyName, description,
873+
labels, etc) and ACL information are returned. This argument can
874+
take on the following possible enum values.
875+
876+
* :attr:`~google.cloud.bigquery.enums.DatasetView.ACL`:
877+
Includes dataset metadata and the ACL.
878+
* :attr:`~google.cloud.bigquery.enums.DatasetView.FULL`:
879+
Includes all dataset metadata, including the ACL and table metadata.
880+
This view is not supported by the `datasets.list` API method.
881+
* :attr:`~google.cloud.bigquery.enums.DatasetView.METADATA`:
882+
Includes basic dataset metadata, but not the ACL.
883+
* :attr:`~google.cloud.bigquery.enums.DatasetView.DATASET_VIEW_UNSPECIFIED`:
884+
The server will decide which view to use. Currently defaults to FULL.
886885
Returns:
887886
google.cloud.bigquery.dataset.Dataset:
888887
A ``Dataset`` instance.

google/cloud/bigquery/enums.py

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,11 +81,21 @@ class CreateDisposition(object):
8181

8282

8383
class DatasetView(enum.Enum):
84-
# TODO add descriptions
84+
"""DatasetView specifies which dataset information is returned."""
85+
8586
DATASET_VIEW_UNSPECIFIED = "DATASET_VIEW_UNSPECIFIED"
87+
"""The default value. Currently maps to the FULL view."""
88+
8689
METADATA = "METADATA"
90+
"""View metadata information for the dataset, such as friendlyName,
91+
description, labels, etc."""
92+
8793
ACL = "ACL"
94+
"""View ACL information for the dataset, which defines dataset access
95+
for one or more entities."""
96+
8897
FULL = "FULL"
98+
"""View both dataset metadata and ACL information."""
8999

90100

91101
class DefaultPandasDTypes(enum.Enum):

0 commit comments

Comments
 (0)