fix: Renaming region tags to not conflict with documentation snippets (…

…#190)
googleapis · Jan 8, 2021 · dd0cdc5 · dd0cdc5
1 parent a6a8883
commit dd0cdc5
Show file tree

Hide file tree

Showing 13 changed files with 392 additions and 392 deletions.
diff --git a/docs/snippets.py b/docs/snippets.py
diff --git a/docs/snippets_table.py b/docs/snippets_table.py
diff --git a/google/cloud/bigtable/app_profile.py b/google/cloud/bigtable/app_profile.py
@@ -93,8 +93,8 @@ def name(self):
         For example:
 
         .. literalinclude:: snippets.py
-            :start-after: [START bigtable_app_profile_name]
-            :end-before: [END bigtable_app_profile_name]
+            :start-after: [START bigtable_api_app_profile_name]
+            :end-before: [END bigtable_api_app_profile_name]
             :dedent: 4
 
         The AppProfile name is of the form
@@ -237,8 +237,8 @@ def reload(self):
         For example:
 
         .. literalinclude:: snippets.py
-            :start-after: [START bigtable_reload_app_profile]
-            :end-before: [END bigtable_reload_app_profile]
+            :start-after: [START bigtable_api_reload_app_profile]
+            :end-before: [END bigtable_api_reload_app_profile]
             :dedent: 4
         """
 
@@ -254,8 +254,8 @@ def exists(self):
         For example:
 
         .. literalinclude:: snippets.py
-            :start-after: [START bigtable_app_profile_exists]
-            :end-before: [END bigtable_app_profile_exists]
+            :start-after: [START bigtable_api_app_profile_exists]
+            :end-before: [END bigtable_api_app_profile_exists]
             :dedent: 4
 
         :rtype: bool
@@ -281,8 +281,8 @@ def create(self, ignore_warnings=None):
         For example:
 
         .. literalinclude:: snippets.py
-            :start-after: [START bigtable_create_app_profile]
-            :end-before: [END bigtable_create_app_profile]
+            :start-after: [START bigtable_api_create_app_profile]
+            :end-before: [END bigtable_api_create_app_profile]
             :dedent: 4
 
         :type: ignore_warnings: bool
@@ -313,8 +313,8 @@ def update(self, ignore_warnings=None):
         For example:
 
         .. literalinclude:: snippets.py
-            :start-after: [START bigtable_update_app_profile]
-            :end-before: [END bigtable_update_app_profile]
+            :start-after: [START bigtable_api_update_app_profile]
+            :end-before: [END bigtable_api_update_app_profile]
             :dedent: 4
         """
         update_mask_pb = field_mask_pb2.FieldMask()
@@ -339,8 +339,8 @@ def delete(self, ignore_warnings=None):
         For example:
 
         .. literalinclude:: snippets.py
-            :start-after: [START bigtable_delete_app_profile]
-            :end-before: [END bigtable_delete_app_profile]
+            :start-after: [START bigtable_api_delete_app_profile]
+            :end-before: [END bigtable_api_delete_app_profile]
             :dedent: 4
 
         :type: ignore_warnings: bool

diff --git a/google/cloud/bigtable/batcher.py b/google/cloud/bigtable/batcher.py
@@ -71,8 +71,8 @@ def mutate(self, row):
         For example:
 
         .. literalinclude:: snippets.py
-            :start-after: [START bigtable_batcher_mutate]
-            :end-before: [END bigtable_batcher_mutate]
+            :start-after: [START bigtable_api_batcher_mutate]
+            :end-before: [END bigtable_api_batcher_mutate]
             :dedent: 4
 
         :type row: class
@@ -111,8 +111,8 @@ def mutate_rows(self, rows):
         For example:
 
         .. literalinclude:: snippets.py
-            :start-after: [START bigtable_batcher_mutate_rows]
-            :end-before: [END bigtable_batcher_mutate_rows]
+            :start-after: [START bigtable_api_batcher_mutate_rows]
+            :end-before: [END bigtable_api_batcher_mutate_rows]
             :dedent: 4
 
         :type rows: list:[`~google.cloud.bigtable.row.DirectRow`]
@@ -134,8 +134,8 @@ def flush(self):
         For example:
 
         .. literalinclude:: snippets.py
-            :start-after: [START bigtable_batcher_flush]
-            :end-before: [END bigtable_batcher_flush]
+            :start-after: [START bigtable_api_batcher_flush]
+            :end-before: [END bigtable_api_batcher_flush]
             :dedent: 4
 
         """

diff --git a/google/cloud/bigtable/client.py b/google/cloud/bigtable/client.py
@@ -208,8 +208,8 @@ def project_path(self):
         For example:
 
         .. literalinclude:: snippets.py
-            :start-after: [START bigtable_project_path]
-            :end-before: [END bigtable_project_path]
+            :start-after: [START bigtable_api_project_path]
+            :end-before: [END bigtable_api_project_path]
             :dedent: 4
 
         The project name is of the form
@@ -228,8 +228,8 @@ def table_data_client(self):
         For example:
 
         .. literalinclude:: snippets.py
-            :start-after: [START bigtable_table_data_client]
-            :end-before: [END bigtable_table_data_client]
+            :start-after: [START bigtable_api_table_data_client]
+            :end-before: [END bigtable_api_table_data_client]
             :dedent: 4
 
         :rtype: :class:`.bigtable_v2.BigtableClient`
@@ -249,8 +249,8 @@ def table_admin_client(self):
         For example:
 
         .. literalinclude:: snippets.py
-            :start-after: [START bigtable_table_admin_client]
-            :end-before: [END bigtable_table_admin_client]
+            :start-after: [START bigtable_api_table_admin_client]
+            :end-before: [END bigtable_api_table_admin_client]
             :dedent: 4
 
         :rtype: :class:`.bigtable_admin_pb2.BigtableTableAdmin`
@@ -276,8 +276,8 @@ def instance_admin_client(self):
         For example:
 
         .. literalinclude:: snippets.py
-            :start-after: [START bigtable_instance_admin_client]
-            :end-before: [END bigtable_instance_admin_client]
+            :start-after: [START bigtable_api_instance_admin_client]
+            :end-before: [END bigtable_api_instance_admin_client]
             :dedent: 4
 
         :rtype: :class:`.bigtable_admin_pb2.BigtableInstanceAdmin`
@@ -302,8 +302,8 @@ def instance(self, instance_id, display_name=None, instance_type=None, labels=No
         For example:
 
         .. literalinclude:: snippets.py
-            :start-after: [START bigtable_create_prod_instance]
-            :end-before: [END bigtable_create_prod_instance]
+            :start-after: [START bigtable_api_create_prod_instance]
+            :end-before: [END bigtable_api_create_prod_instance]
             :dedent: 4
 
         :type instance_id: str
@@ -352,8 +352,8 @@ def list_instances(self):
         For example:
 
         .. literalinclude:: snippets.py
-            :start-after: [START bigtable_list_instances]
-            :end-before: [END bigtable_list_instances]
+            :start-after: [START bigtable_api_list_instances]
+            :end-before: [END bigtable_api_list_instances]
             :dedent: 4
 
         :rtype: tuple
@@ -373,8 +373,8 @@ def list_clusters(self):
         For example:
 
         .. literalinclude:: snippets.py
-            :start-after: [START bigtable_list_clusters_in_project]
-            :end-before: [END bigtable_list_clusters_in_project]
+            :start-after: [START bigtable_api_list_clusters_in_project]
+            :end-before: [END bigtable_api_list_clusters_in_project]
             :dedent: 4
 
         :rtype: tuple

diff --git a/google/cloud/bigtable/cluster.py b/google/cloud/bigtable/cluster.py
@@ -97,8 +97,8 @@ def from_pb(cls, cluster_pb, instance):
         For example:
 
         .. literalinclude:: snippets.py
-            :start-after: [START bigtable_cluster_from_pb]
-            :end-before: [END bigtable_cluster_from_pb]
+            :start-after: [START bigtable_api_cluster_from_pb]
+            :end-before: [END bigtable_api_cluster_from_pb]
             :dedent: 4
 
         :type cluster_pb: :class:`instance_pb2.Cluster`
@@ -158,8 +158,8 @@ def name(self):
         For example:
 
         .. literalinclude:: snippets.py
-            :start-after: [START bigtable_cluster_name]
-            :end-before: [END bigtable_cluster_name]
+            :start-after: [START bigtable_api_cluster_name]
+            :end-before: [END bigtable_api_cluster_name]
             :dedent: 4
 
         The cluster name is of the form
@@ -180,8 +180,8 @@ def state(self):
         For example:
 
         .. literalinclude:: snippets.py
-            :start-after: [START bigtable_cluster_state]
-            :end-before: [END bigtable_cluster_state]
+            :start-after: [START bigtable_api_cluster_state]
+            :end-before: [END bigtable_api_cluster_state]
             :dedent: 4
 
         """
@@ -207,8 +207,8 @@ def reload(self):
         For example:
 
         .. literalinclude:: snippets.py
-            :start-after: [START bigtable_reload_cluster]
-            :end-before: [END bigtable_reload_cluster]
+            :start-after: [START bigtable_api_reload_cluster]
+            :end-before: [END bigtable_api_reload_cluster]
             :dedent: 4
         """
         cluster_pb = self._instance._client.instance_admin_client.get_cluster(self.name)
@@ -223,8 +223,8 @@ def exists(self):
         For example:
 
         .. literalinclude:: snippets.py
-            :start-after: [START bigtable_check_cluster_exists]
-            :end-before: [END bigtable_check_cluster_exists]
+            :start-after: [START bigtable_api_check_cluster_exists]
+            :end-before: [END bigtable_api_check_cluster_exists]
             :dedent: 4
 
         :rtype: bool
@@ -244,8 +244,8 @@ def create(self):
         For example:
 
         .. literalinclude:: snippets.py
-            :start-after: [START bigtable_create_cluster]
-            :end-before: [END bigtable_create_cluster]
+            :start-after: [START bigtable_api_create_cluster]
+            :end-before: [END bigtable_api_create_cluster]
             :dedent: 4
 
         .. note::
@@ -278,8 +278,8 @@ def update(self):
         For example:
 
         .. literalinclude:: snippets.py
-            :start-after: [START bigtable_update_cluster]
-            :end-before: [END bigtable_update_cluster]
+            :start-after: [START bigtable_api_update_cluster]
+            :end-before: [END bigtable_api_update_cluster]
             :dedent: 4
 
         .. note::
@@ -311,8 +311,8 @@ def delete(self):
         For example:
 
         .. literalinclude:: snippets.py
-            :start-after: [START bigtable_delete_cluster]
-            :end-before: [END bigtable_delete_cluster]
+            :start-after: [START bigtable_api_delete_cluster]
+            :end-before: [END bigtable_api_delete_cluster]
             :dedent: 4
 
         Marks a cluster and all of its tables for permanent deletion in 7 days.

diff --git a/google/cloud/bigtable/column_family.py b/google/cloud/bigtable/column_family.py
@@ -46,8 +46,8 @@ class MaxVersionsGCRule(GarbageCollectionRule):
     For example:
 
     .. literalinclude:: snippets_table.py
-        :start-after: [START bigtable_create_family_gc_max_versions]
-        :end-before: [END bigtable_create_family_gc_max_versions]
+        :start-after: [START bigtable_api_create_family_gc_max_versions]
+        :end-before: [END bigtable_api_create_family_gc_max_versions]
         :dedent: 4
 
     :type max_num_versions: int
@@ -80,8 +80,8 @@ class MaxAgeGCRule(GarbageCollectionRule):
     For example:
 
     .. literalinclude:: snippets_table.py
-        :start-after: [START bigtable_create_family_gc_max_age]
-        :end-before: [END bigtable_create_family_gc_max_age]
+        :start-after: [START bigtable_api_create_family_gc_max_age]
+        :end-before: [END bigtable_api_create_family_gc_max_age]
         :dedent: 4
 
     :type max_age: :class:`datetime.timedelta`
@@ -115,8 +115,8 @@ class GCRuleUnion(GarbageCollectionRule):
     For example:
 
     .. literalinclude:: snippets_table.py
-        :start-after: [START bigtable_create_family_gc_union]
-        :end-before: [END bigtable_create_family_gc_union]
+        :start-after: [START bigtable_api_create_family_gc_union]
+        :end-before: [END bigtable_api_create_family_gc_union]
         :dedent: 4
 
     :type rules: list
@@ -150,8 +150,8 @@ class GCRuleIntersection(GarbageCollectionRule):
     For example:
 
     .. literalinclude:: snippets_table.py
-        :start-after: [START bigtable_create_family_gc_intersection]
-        :end-before: [END bigtable_create_family_gc_intersection]
+        :start-after: [START bigtable_api_create_family_gc_intersection]
+        :end-before: [END bigtable_api_create_family_gc_intersection]
         :dedent: 4
 
     :type rules: list
@@ -214,8 +214,8 @@ def name(self):
         For example:
 
         .. literalinclude:: snippets_table.py
-            :start-after: [START bigtable_column_family_name]
-            :end-before: [END bigtable_column_family_name]
+            :start-after: [START bigtable_api_column_family_name]
+            :end-before: [END bigtable_api_column_family_name]
             :dedent: 4
 
         .. note::
@@ -261,8 +261,8 @@ def create(self):
         For example:
 
         .. literalinclude:: snippets_table.py
-            :start-after: [START bigtable_create_column_family]
-            :end-before: [END bigtable_create_column_family]
+            :start-after: [START bigtable_api_create_column_family]
+            :end-before: [END bigtable_api_create_column_family]
             :dedent: 4
 
         """
@@ -284,8 +284,8 @@ def update(self):
         For example:
 
         .. literalinclude:: snippets_table.py
-            :start-after: [START bigtable_update_column_family]
-            :end-before: [END bigtable_update_column_family]
+            :start-after: [START bigtable_api_update_column_family]
+            :end-before: [END bigtable_api_update_column_family]
             :dedent: 4
 
         .. note::
@@ -311,8 +311,8 @@ def delete(self):
         For example:
 
         .. literalinclude:: snippets_table.py
-            :start-after: [START bigtable_delete_column_family]
-            :end-before: [END bigtable_delete_column_family]
+            :start-after: [START bigtable_api_delete_column_family]
+            :end-before: [END bigtable_api_delete_column_family]
             :dedent: 4
 
         """