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

BigQuery: use full sub-module aliases in docstrings. #4255

Merged
merged 1 commit into from
Oct 25, 2017
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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions bigquery/google/cloud/bigquery/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,11 @@

The main concepts with this API are:

- :class:`~google.cloud.bigquery.client.Client` manages connections to the
BigQuery API. Use the client methods to run jobs (such as a
:class:`~google.cloud.bigquery.job.QueryJob` via
:meth:`~google.cloud.bigquery.client.Client.query`) and manage resources.

- :class:`~google.cloud.bigquery.dataset.Dataset` represents a
collection of tables.

Expand Down
127 changes: 64 additions & 63 deletions bigquery/google/cloud/bigquery/client.py

Large diffs are not rendered by default.

18 changes: 10 additions & 8 deletions bigquery/google/cloud/bigquery/dataset.py
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ def table(self, table_id):
:type table_id: str
:param table_id: the ID of the table.

:rtype: :class:`google.cloud.bigquery.TableReference`
:rtype: :class:`google.cloud.bigquery.table.TableReference`
:returns: a TableReference for a table in this dataset.
"""
return TableReference(self, table_id)
Expand Down Expand Up @@ -197,7 +197,7 @@ class Dataset(object):
See
https://cloud.google.com/bigquery/docs/reference/rest/v2/datasets

:type dataset_ref: :class:`~google.cloud.bigquery.DatasetReference`
:type dataset_ref: :class:`~google.cloud.bigquery.dataset.DatasetReference`
:param dataset_ref: a pointer to a dataset
"""

Expand Down Expand Up @@ -238,7 +238,8 @@ def access_entries(self):
def access_entries(self, value):
"""Update dataset's access entries

:type value: list of :class:`~google.cloud.bigquery.AccessEntry`
:type value:
list of :class:`~google.cloud.bigquery.dataset.AccessEntry`
:param value: roles granted to entities for this dataset

:raises: TypeError if 'value' is not a sequence, or ValueError if
Expand Down Expand Up @@ -401,8 +402,9 @@ def labels(self):
"""Labels for the dataset.

This method always returns a dict. To change a dataset's labels,
modify the dict, then call ``Client.update_dataset``. To delete a
label, set its value to ``None`` before updating.
modify the dict, then call
:meth:`google.cloud.bigquery.client.Client.update_dataset`. To delete
a label, set its value to ``None`` before updating.

:rtype: dict, {str -> str}
:returns: A dict of the the dataset's labels.
Expand All @@ -429,7 +431,7 @@ def from_api_repr(cls, resource):
:type resource: dict
:param resource: dataset resource representation returned from the API

:rtype: :class:`~google.cloud.bigquery.Dataset`
:rtype: :class:`~google.cloud.bigquery.dataset.Dataset`
:returns: Dataset parsed from ``resource``.
"""
dsr = resource.get('datasetReference')
Expand All @@ -451,7 +453,7 @@ def _parse_access_entries(access):
:type access: list of mappings
:param access: each mapping represents a single access entry.

:rtype: list of :class:`~google.cloud.bigquery.AccessEntry`
:rtype: list of :class:`~google.cloud.bigquery.dataset.AccessEntry`
:returns: a list of parsed entries.
:raises: :class:`ValueError` if a entry in ``access`` has more keys
than ``role`` and one additional key.
Expand Down Expand Up @@ -530,7 +532,7 @@ def table(self, table_id):
:type table_id: str
:param table_id: the ID of the table.

:rtype: :class:`~google.cloud.bigquery.TableReference`
:rtype: :class:`~google.cloud.bigquery.table.TableReference`
:returns: a TableReference for a table in this dataset.
"""
return TableReference(self, table_id)
11 changes: 6 additions & 5 deletions bigquery/google/cloud/bigquery/external_config.py
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ def from_api_repr(cls, resource):
from the API.

:rtype:
:class:`~google.cloud.bigquery.BigtableColumnFamily`
:class:`~google.cloud.bigquery.external_config.BigtableColumnFamily`
:returns: Configuration parsed from ``resource``.
"""
config = cls()
Expand Down Expand Up @@ -239,7 +239,8 @@ def from_api_repr(cls, resource):
A BigtableOptions in the same representation as is returned
from the API.

:rtype: :class:`~google.cloud.bigquery.BigtableOptions`
:rtype:
:class:`~google.cloud.bigquery.external_config.BigtableOptions`
:returns: Configuration parsed from ``resource``.
"""
config = cls()
Expand Down Expand Up @@ -321,7 +322,7 @@ def from_api_repr(cls, resource):
A CSVOptions in the same representation as is
returned from the API.

:rtype: :class:`~google.cloud.bigquery.CSVOptions`
:rtype: :class:`~google.cloud.bigquery.external_config.CSVOptions`
:returns: Configuration parsed from ``resource``.
"""
slr = resource.get('skipLeadingRows')
Expand Down Expand Up @@ -369,7 +370,7 @@ def from_api_repr(cls, resource):
returned from the API.

:rtype:
:class:`~google.cloud.bigquery.GoogleSheetsOptions`
:class:`~google.cloud.bigquery.external_config.GoogleSheetsOptions`
:returns: Configuration parsed from ``resource``.
"""
slr = resource.get('skipLeadingRows')
Expand Down Expand Up @@ -476,7 +477,7 @@ def from_api_repr(cls, resource):
An extract job configuration in the same representation as is
returned from the API.

:rtype: :class:`~google.cloud.bigquery.CSVOptions`
:rtype: :class:`~google.cloud.bigquery.external_config.CSVOptions`
:returns: Configuration parsed from ``resource``.
"""
config = cls(resource['sourceFormat'])
Expand Down
Loading