Skip to content

Commit 45d81a0

Browse files
committed
Fix-up docstrings after Connection() signature change.
1 parent 111c7ef commit 45d81a0

File tree

9 files changed

+33
-41
lines changed

9 files changed

+33
-41
lines changed

bigquery/google/cloud/bigquery/_http.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,11 @@
1818

1919

2020
class Connection(_http.JSONConnection):
21-
"""A connection to Google BigQuery via the JSON REST API."""
21+
"""A connection to Google BigQuery via the JSON REST API.
22+
23+
:type client: :class:`~google.cloud.bigquery.client.Client`
24+
:param client: The client that owns the current connection.
25+
"""
2226

2327
API_BASE_URL = 'https://www.googleapis.com'
2428
"""The base of the API call URL."""

dns/google/cloud/dns/connection.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,11 @@
1818

1919

2020
class Connection(_http.JSONConnection):
21-
"""A connection to Google Cloud DNS via the JSON REST API."""
21+
"""A connection to Google Cloud DNS via the JSON REST API.
22+
23+
:type client: :class:`~google.cloud.dns.client.Client`
24+
:param client: The client that owns the current connection.
25+
"""
2226

2327
API_BASE_URL = 'https://www.googleapis.com'
2428
"""The base of the API call URL."""

language/google/cloud/language/connection.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,11 @@
1818

1919

2020
class Connection(_http.JSONConnection):
21-
"""A connection to Google Cloud Natural Language JSON REST API."""
21+
"""A connection to Google Cloud Natural Language JSON REST API.
22+
23+
:type client: :class:`~google.cloud.language.client.Client`
24+
:param client: The client that owns the current connection.
25+
"""
2226

2327
API_BASE_URL = 'https://language.googleapis.com'
2428
"""The base of the API call URL."""

monitoring/google/cloud/monitoring/connection.py

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -20,16 +20,8 @@
2020
class Connection(_http.JSONConnection):
2121
"""A connection to Google Stackdriver Monitoring via the JSON REST API.
2222
23-
:type credentials: :class:`oauth2client.client.OAuth2Credentials`
24-
:param credentials: (Optional) The OAuth2 Credentials to use for this
25-
connection.
26-
27-
:type http: :class:`httplib2.Http` or class that defines ``request()``
28-
:param http: (Optional) HTTP object to make requests.
29-
30-
:type api_base_url: str
31-
:param api_base_url: The base of the API call URL. Defaults to the value
32-
:attr:`Connection.API_BASE_URL`.
23+
:type client: :class:`~google.cloud.monitoring.client.Client`
24+
:param client: The client that owns the current connection.
3325
"""
3426

3527
API_BASE_URL = 'https://monitoring.googleapis.com'

resource_manager/google/cloud/resource_manager/connection.py

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,8 @@
2121
class Connection(_http.JSONConnection):
2222
"""A connection to Google Cloud Resource Manager via the JSON REST API.
2323
24-
:type credentials: :class:`oauth2client.client.OAuth2Credentials`
25-
:param credentials: (Optional) The OAuth2 Credentials to use for this
26-
connection.
27-
28-
:type http: :class:`httplib2.Http` or class that defines ``request()``.
29-
:param http: (Optional) HTTP object to make requests.
24+
:type client: :class:`~google.cloud.resource_manager.client.Client`
25+
:param client: The client that owns the current connection.
3026
"""
3127

3228
API_BASE_URL = 'https://cloudresourcemanager.googleapis.com'

runtimeconfig/google/cloud/runtimeconfig/connection.py

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -22,16 +22,8 @@
2222
class Connection(_http.JSONConnection):
2323
"""A connection to Google Cloud RuntimeConfig via the JSON REST API.
2424
25-
:type credentials: :class:`oauth2client.client.OAuth2Credentials`
26-
:param credentials: (Optional) The OAuth2 Credentials to use for this
27-
connection.
28-
29-
:type http: :class:`httplib2.Http` or class that defines ``request()``.
30-
:param http: (Optional) HTTP object to make requests.
31-
32-
:type api_base_url: str
33-
:param api_base_url: The base of the API call URL. Defaults to the value
34-
:attr:`Connection.API_BASE_URL`.
25+
:type client: :class:`~google.cloud.runtimeconfig.client.Client`
26+
:param client: The client that owns the current connection.
3527
"""
3628

3729
API_BASE_URL = 'https://runtimeconfig.googleapis.com'

speech/google/cloud/speech/connection.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,11 @@
1818

1919

2020
class Connection(_http.JSONConnection):
21-
"""A connection to Google Cloud Speech JSON REST API."""
21+
"""A connection to Google Cloud Speech JSON REST API.
22+
23+
:type client: :class:`~google.cloud.speech.client.Client`
24+
:param client: The client that owns the current connection.
25+
"""
2226

2327
API_BASE_URL = 'https://speech.googleapis.com'
2428
"""The base of the API call URL."""

translate/google/cloud/translate/connection.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,11 @@
1818

1919

2020
class Connection(_http.JSONConnection):
21-
"""A connection to Google Cloud Translation API via the JSON REST API."""
21+
"""A connection to Google Cloud Translation API via the JSON REST API.
22+
23+
:type client: :class:`~google.cloud.translate.client.Client`
24+
:param client: The client that owns the current connection.
25+
"""
2226

2327
API_BASE_URL = 'https://translation.googleapis.com'
2428
"""The base of the API call URL."""

vision/google/cloud/vision/connection.py

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -22,16 +22,8 @@
2222
class Connection(_http.JSONConnection):
2323
"""A connection to Google Cloud Vision via the JSON REST API.
2424
25-
:type credentials: :class:`oauth2client.client.OAuth2Credentials`
26-
:param credentials: (Optional) The OAuth2 Credentials to use for this
27-
connection.
28-
29-
:type http: :class:`httplib2.Http` or class that defines ``request()``.
30-
:param http: (Optional) HTTP object to make requests.
31-
32-
:type api_base_url: str
33-
:param api_base_url: The base of the API call URL. Defaults to the value
34-
:attr:`Connection.API_BASE_URL`.
25+
:type client: :class:`~google.cloud.vision.client.Client`
26+
:param client: The client that owns the current connection.
3527
"""
3628

3729
API_BASE_URL = 'https://vision.googleapis.com'

0 commit comments

Comments
 (0)