docs(spanner): fix single character parameter (#48)

HemangChothani · web-flow · commit 0f526bf8fb2a · 2020-04-17T07:34:14.000+10:00
* docs(spanner): fix single character parameter

* docs(spanner): fix single character parameters

* docs(spanner): fix lint

* docs(spanner): nits

* docs(spanner): nit
diff --git a/google/cloud/spanner_v1/client.py b/google/cloud/spanner_v1/client.py
@@ -127,7 +127,7 @@ class Client(ClientWithProject):
                         If none are specified, the client will attempt to ascertain
                         the credentials from the environment.
 
-    :type client_info: :class:`google.api_core.gapic_v1.client_info.ClientInfo`
+    :type client_info: :class:`~google.api_core.gapic_v1.client_info.ClientInfo`
     :param client_info:
         (Optional) The client info used to send a user-agent string along with
         API requests. If ``None``, then default info will be used. Generally,
@@ -145,7 +145,7 @@ class Client(ClientWithProject):
         on the client. API Endpoint should be set through client_options.
 
     :type query_options:
-        :class:`google.cloud.spanner_v1.proto.ExecuteSqlRequest.QueryOptions`
+        :class:`~google.cloud.spanner_v1.proto.ExecuteSqlRequest.QueryOptions`
         or :class:`dict`
     :param query_options:
         (Optional) Query optimizer configuration to use for the given query.
@@ -341,7 +341,8 @@ def instance(
         :param configuration_name:
            (Optional) Name of the instance configuration used to set up the
            instance's cluster, in the form:
-           ``projects/<project>/instanceConfigs/<config>``.
+           ``projects/<project>/instanceConfigs/``
+           ``<config>``.
            **Required** for instances which do not yet exist.
 
         :type display_name: str
diff --git a/google/cloud/spanner_v1/database.py b/google/cloud/spanner_v1/database.py
@@ -129,7 +129,7 @@ def from_pb(cls, database_pb, instance, pool=None):
         """Creates an instance of this class from a protobuf.
 
         :type database_pb:
-            :class:`google.spanner.v2.spanner_instance_admin_pb2.Instance`
+            :class:`~google.spanner.v2.spanner_instance_admin_pb2.Instance`
         :param database_pb: A instance protobuf object.
 
         :type instance: :class:`~google.cloud.spanner_v1.instance.Instance`
@@ -410,7 +410,7 @@ def execute_partitioned_dml(
             required if parameters are passed.
 
         :type query_options:
-            :class:`google.cloud.spanner_v1.proto.ExecuteSqlRequest.QueryOptions`
+            :class:`~google.cloud.spanner_v1.proto.ExecuteSqlRequest.QueryOptions`
             or :class:`dict`
         :param query_options:
                 (Optional) Query optimizer configuration to use for the given query.
@@ -566,7 +566,7 @@ def restore(self, source):
         :type backup: :class:`~google.cloud.spanner_v1.backup.Backup`
         :param backup: the path of the backup being restored from.
 
-        :rtype: :class:'~google.api_core.operation.Operation`
+        :rtype: :class:`~google.api_core.operation.Operation`
         :returns: a future used to poll the status of the create request
         :raises Conflict: if the database already exists
         :raises NotFound:
@@ -908,7 +908,7 @@ def generate_query_batches(
             differ.
 
         :type query_options:
-            :class:`google.cloud.spanner_v1.proto.ExecuteSqlRequest.QueryOptions`
+            :class:`~google.cloud.spanner_v1.proto.ExecuteSqlRequest.QueryOptions`
             or :class:`dict`
         :param query_options:
                 (Optional) Query optimizer configuration to use for the given query.
diff --git a/google/cloud/spanner_v1/instance.py b/google/cloud/spanner_v1/instance.py
@@ -135,7 +135,7 @@ def from_pb(cls, instance_pb, client):
         """Creates an instance from a protobuf.
 
         :type instance_pb:
-            :class:`google.spanner.v2.spanner_instance_admin_pb2.Instance`
+            :class:`~google.spanner.v2.spanner_instance_admin_pb2.Instance`
         :param instance_pb: A instance protobuf object.
 
         :type client: :class:`~google.cloud.spanner_v1.client.Client`
@@ -234,7 +234,7 @@ def create(self):
 
            before calling :meth:`create`.
 
-        :rtype: :class:`google.api_core.operation.Operation`
+        :rtype: :class:`~google.api_core.operation.Operation`
         :returns: an operation instance
         :raises Conflict: if the instance already exists
         """
diff --git a/google/cloud/spanner_v1/session.py b/google/cloud/spanner_v1/session.py
@@ -216,18 +216,18 @@ def execute_sql(
                        the names used in ``sql``.
 
         :type param_types:
-            dict, {str -> :class:`google.spanner.v1.type_pb2.TypeCode`}
+            dict, {str -> :class:`~google.spanner.v1.type_pb2.TypeCode`}
         :param param_types: (Optional) explicit types for one or more param
                             values;  overrides default type detection on the
                             back-end.
 
         :type query_mode:
-            :class:`google.spanner.v1.spanner_pb2.ExecuteSqlRequest.QueryMode`
-        :param query_mode: Mode governing return of results / query plan. See
-            https://cloud.google.com/spanner/reference/rpc/google.spanner.v1#google.spanner.v1.ExecuteSqlRequest.QueryMode1
+            :class:`~google.spanner.v1.spanner_pb2.ExecuteSqlRequest.QueryMode`
+        :param query_mode: Mode governing return of results / query plan. See:
+            `QueryMode <https://cloud.google.com/spanner/reference/rpc/google.spanner.v1#google.spanner.v1.ExecuteSqlRequest.QueryMode>`_.
 
         :type query_options:
-            :class:`google.cloud.spanner_v1.proto.ExecuteSqlRequest.QueryOptions`
+            :class:`~google.cloud.spanner_v1.proto.ExecuteSqlRequest.QueryOptions`
             or :class:`dict`
         :param query_options: (Optional) Options that are provided for query plan stability.
 
diff --git a/google/cloud/spanner_v1/snapshot.py b/google/cloud/spanner_v1/snapshot.py
@@ -178,12 +178,13 @@ def execute_sql(
             required if parameters are passed.
 
         :type query_mode:
-            :class:`google.cloud.spanner_v1.proto.ExecuteSqlRequest.QueryMode`
-        :param query_mode: Mode governing return of results / query plan. See
-            https://cloud.google.com/spanner/reference/rpc/google.spanner.v1#google.spanner.v1.ExecuteSqlRequest.QueryMode1
+            :class:`~google.cloud.spanner_v1.proto.ExecuteSqlRequest.QueryMode`
+        :param query_mode: Mode governing return of results / query plan.
+            See:
+            `QueryMode <https://cloud.google.com/spanner/reference/rpc/google.spanner.v1#google.spanner.v1.ExecuteSqlRequest.QueryMode>`_.
 
         :type query_options:
-            :class:`google.cloud.spanner_v1.proto.ExecuteSqlRequest.QueryOptions`
+            :class:`~google.cloud.spanner_v1.proto.ExecuteSqlRequest.QueryOptions`
                 or :class:`dict`
         :param query_options:
                 (Optional) Query optimizer configuration to use for the given query.
diff --git a/google/cloud/spanner_v1/streamed.py b/google/cloud/spanner_v1/streamed.py
@@ -32,7 +32,7 @@ class StreamedResultSet(object):
     :type response_iterator:
     :param response_iterator:
         Iterator yielding
-        :class:`google.cloud.spanner_v1.proto.result_set_pb2.PartialResultSet`
+        :class:`~google.cloud.spanner_v1.proto.result_set_pb2.PartialResultSet`
         instances.
 
     :type source: :class:`~google.cloud.spanner_v1.snapshot.Snapshot`
@@ -195,13 +195,13 @@ def one_or_none(self):
 class Unmergeable(ValueError):
     """Unable to merge two values.
 
-    :type lhs: :class:`google.protobuf.struct_pb2.Value`
+    :type lhs: :class:`~google.protobuf.struct_pb2.Value`
     :param lhs: pending value to be merged
 
-    :type rhs: :class:`google.protobuf.struct_pb2.Value`
+    :type rhs: :class:`~google.protobuf.struct_pb2.Value`
     :param rhs: remaining value to be merged
 
-    :type type_: :class:`google.cloud.spanner_v1.proto.type_pb2.Type`
+    :type type_: :class:`~google.cloud.spanner_v1.proto.type_pb2.Type`
     :param type_: field type of values being merged
     """
 
diff --git a/google/cloud/spanner_v1/transaction.py b/google/cloud/spanner_v1/transaction.py
@@ -183,12 +183,13 @@ def execute_update(
             required if parameters are passed.
 
         :type query_mode:
-            :class:`google.cloud.spanner_v1.proto.ExecuteSqlRequest.QueryMode`
-        :param query_mode: Mode governing return of results / query plan. See
-            https://cloud.google.com/spanner/reference/rpc/google.spanner.v1#google.spanner.v1.ExecuteSqlRequest.QueryMode1
+            :class:`~google.cloud.spanner_v1.proto.ExecuteSqlRequest.QueryMode`
+        :param query_mode: Mode governing return of results / query plan.
+            See:
+            `QueryMode <https://cloud.google.com/spanner/reference/rpc/google.spanner.v1#google.spanner.v1.ExecuteSqlRequest.QueryMode>`_.
 
         :type query_options:
-            :class:`google.cloud.spanner_v1.proto.ExecuteSqlRequest.QueryOptions`
+            :class:`~google.cloud.spanner_v1.proto.ExecuteSqlRequest.QueryOptions`
             or :class:`dict`
         :param query_options: (Optional) Options that are provided for query plan stability.
 
