Skip to content

Commit 69541cb

Browse files
authored
Fix Sphinx crossrefs to 'Client'. (googleapis#5764)
Broken by move to 'spanner_v1' (the aliases in 'spanner' are not honored). Closes googleapis#5723.
1 parent af8547f commit 69541cb

1 file changed

Lines changed: 14 additions & 14 deletions

File tree

docs/spanner/usage.rst

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -42,23 +42,23 @@ Spanner Client
4242
Instantiating a Client
4343
----------------------
4444

45-
To use the API, the :class:`~google.cloud.spanner.client.Client`
45+
To use the API, the :class:`~google.cloud.spanner_v1.client.Client`
4646
class defines a high-level interface which handles authorization
4747
and creating other objects:
4848

4949
.. code:: python
5050
51-
from google.cloud import spanner
52-
client = spanner.Client()
51+
from google.cloud import spanner_v1
52+
client = spanner_v1.Client()
5353
5454
Long-lived Defaults
5555
-------------------
5656

57-
When creating a :class:`~google.cloud.spanner.client.Client`, the
57+
When creating a :class:`~google.cloud.spanner_v1.client.Client`, the
5858
``user_agent`` and ``timeout_seconds`` arguments have sensible
5959
defaults
60-
(:data:`~google.cloud.spanner.client.DEFAULT_USER_AGENT` and
61-
:data:`~google.cloud.spanner.client.DEFAULT_TIMEOUT_SECONDS`).
60+
(:data:`~google.cloud.spanner_v1.client.DEFAULT_USER_AGENT` and
61+
:data:`~google.cloud.spanner_v1.client.DEFAULT_TIMEOUT_SECONDS`).
6262
However, you may over-ride them and these will be used throughout all API
6363
requests made with the ``client`` you create.
6464

@@ -74,22 +74,22 @@ Configuration
7474
Engine or Google Compute Engine the project will be detected automatically.
7575
(Setting this environment variable is not required, you may instead pass the
7676
``project`` explicitly when constructing a
77-
:class:`~google.cloud.spanner.client.Client`).
77+
:class:`~google.cloud.spanner_v1.client.Client`).
7878

7979
- After configuring your environment, create a
80-
:class:`~google.cloud.spanner.client.Client`
80+
:class:`~google.cloud.spanner_v1.client.Client`
8181

8282
.. code::
8383
84-
>>> from google.cloud import spanner
85-
>>> client = spanner.Client()
84+
>>> from google.cloud import spanner_v1
85+
>>> client = spanner_v1.Client()
8686
8787
or pass in ``credentials`` and ``project`` explicitly
8888

8989
.. code::
9090
91-
>>> from google.cloud import spanner
92-
>>> client = spanner.Client(project='my-project', credentials=creds)
91+
>>> from google.cloud import spanner_v1
92+
>>> client = spanner_v1.Client(project='my-project', credentials=creds)
9393
9494
.. tip::
9595

@@ -106,8 +106,8 @@ Warnings about Multiprocessing
106106
Next Step
107107
---------
108108

109-
After a :class:`~google.cloud.spanner.client.Client`, the next
110-
highest-level object is an :class:`~google.cloud.spanner.instance.Instance`.
109+
After a :class:`~google.cloud.spanner_v1.client.Client`, the next
110+
highest-level object is an :class:`~google.cloud.spanner_v1.instance.Instance`.
111111
You'll need one before you can interact with databases.
112112

113113
Next, learn about the :doc:`instance-usage`.

0 commit comments

Comments
 (0)