Skip to content
This repository was archived by the owner on Aug 30, 2026. It is now read-only.

Commit dd0cdc5

Browse files
billyjacobsonbillyjacobson
authored
fix: Renaming region tags to not conflict with documentation snippets (#190)
1 parent a6a8883 commit dd0cdc5

13 files changed

Lines changed: 392 additions & 392 deletions

File tree

‎docs/snippets.py‎

Lines changed: 78 additions & 78 deletions
Large diffs are not rendered by default.

‎docs/snippets_table.py‎

Lines changed: 112 additions & 112 deletions
Large diffs are not rendered by default.

‎google/cloud/bigtable/app_profile.py‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -93,8 +93,8 @@ def name(self):
9393
For example:
9494
9595
.. literalinclude:: snippets.py
96-
:start-after: [START bigtable_app_profile_name]
97-
:end-before: [END bigtable_app_profile_name]
96+
:start-after: [START bigtable_api_app_profile_name]
97+
:end-before: [END bigtable_api_app_profile_name]
9898
:dedent: 4
9999
100100
The AppProfile name is of the form
@@ -237,8 +237,8 @@ def reload(self):
237237
For example:
238238
239239
.. literalinclude:: snippets.py
240-
:start-after: [START bigtable_reload_app_profile]
241-
:end-before: [END bigtable_reload_app_profile]
240+
:start-after: [START bigtable_api_reload_app_profile]
241+
:end-before: [END bigtable_api_reload_app_profile]
242242
:dedent: 4
243243
"""
244244

@@ -254,8 +254,8 @@ def exists(self):
254254
For example:
255255
256256
.. literalinclude:: snippets.py
257-
:start-after: [START bigtable_app_profile_exists]
258-
:end-before: [END bigtable_app_profile_exists]
257+
:start-after: [START bigtable_api_app_profile_exists]
258+
:end-before: [END bigtable_api_app_profile_exists]
259259
:dedent: 4
260260
261261
:rtype: bool
@@ -281,8 +281,8 @@ def create(self, ignore_warnings=None):
281281
For example:
282282
283283
.. literalinclude:: snippets.py
284-
:start-after: [START bigtable_create_app_profile]
285-
:end-before: [END bigtable_create_app_profile]
284+
:start-after: [START bigtable_api_create_app_profile]
285+
:end-before: [END bigtable_api_create_app_profile]
286286
:dedent: 4
287287
288288
:type: ignore_warnings: bool
@@ -313,8 +313,8 @@ def update(self, ignore_warnings=None):
313313
For example:
314314
315315
.. literalinclude:: snippets.py
316-
:start-after: [START bigtable_update_app_profile]
317-
:end-before: [END bigtable_update_app_profile]
316+
:start-after: [START bigtable_api_update_app_profile]
317+
:end-before: [END bigtable_api_update_app_profile]
318318
:dedent: 4
319319
"""
320320
update_mask_pb = field_mask_pb2.FieldMask()
@@ -339,8 +339,8 @@ def delete(self, ignore_warnings=None):
339339
For example:
340340
341341
.. literalinclude:: snippets.py
342-
:start-after: [START bigtable_delete_app_profile]
343-
:end-before: [END bigtable_delete_app_profile]
342+
:start-after: [START bigtable_api_delete_app_profile]
343+
:end-before: [END bigtable_api_delete_app_profile]
344344
:dedent: 4
345345
346346
:type: ignore_warnings: bool

‎google/cloud/bigtable/batcher.py‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -71,8 +71,8 @@ def mutate(self, row):
7171
For example:
7272
7373
.. literalinclude:: snippets.py
74-
:start-after: [START bigtable_batcher_mutate]
75-
:end-before: [END bigtable_batcher_mutate]
74+
:start-after: [START bigtable_api_batcher_mutate]
75+
:end-before: [END bigtable_api_batcher_mutate]
7676
:dedent: 4
7777
7878
:type row: class
@@ -111,8 +111,8 @@ def mutate_rows(self, rows):
111111
For example:
112112
113113
.. literalinclude:: snippets.py
114-
:start-after: [START bigtable_batcher_mutate_rows]
115-
:end-before: [END bigtable_batcher_mutate_rows]
114+
:start-after: [START bigtable_api_batcher_mutate_rows]
115+
:end-before: [END bigtable_api_batcher_mutate_rows]
116116
:dedent: 4
117117
118118
:type rows: list:[`~google.cloud.bigtable.row.DirectRow`]
@@ -134,8 +134,8 @@ def flush(self):
134134
For example:
135135
136136
.. literalinclude:: snippets.py
137-
:start-after: [START bigtable_batcher_flush]
138-
:end-before: [END bigtable_batcher_flush]
137+
:start-after: [START bigtable_api_batcher_flush]
138+
:end-before: [END bigtable_api_batcher_flush]
139139
:dedent: 4
140140
141141
"""

‎google/cloud/bigtable/client.py‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -208,8 +208,8 @@ def project_path(self):
208208
For example:
209209
210210
.. literalinclude:: snippets.py
211-
:start-after: [START bigtable_project_path]
212-
:end-before: [END bigtable_project_path]
211+
:start-after: [START bigtable_api_project_path]
212+
:end-before: [END bigtable_api_project_path]
213213
:dedent: 4
214214
215215
The project name is of the form
@@ -228,8 +228,8 @@ def table_data_client(self):
228228
For example:
229229
230230
.. literalinclude:: snippets.py
231-
:start-after: [START bigtable_table_data_client]
232-
:end-before: [END bigtable_table_data_client]
231+
:start-after: [START bigtable_api_table_data_client]
232+
:end-before: [END bigtable_api_table_data_client]
233233
:dedent: 4
234234
235235
:rtype: :class:`.bigtable_v2.BigtableClient`
@@ -249,8 +249,8 @@ def table_admin_client(self):
249249
For example:
250250
251251
.. literalinclude:: snippets.py
252-
:start-after: [START bigtable_table_admin_client]
253-
:end-before: [END bigtable_table_admin_client]
252+
:start-after: [START bigtable_api_table_admin_client]
253+
:end-before: [END bigtable_api_table_admin_client]
254254
:dedent: 4
255255
256256
:rtype: :class:`.bigtable_admin_pb2.BigtableTableAdmin`
@@ -276,8 +276,8 @@ def instance_admin_client(self):
276276
For example:
277277
278278
.. literalinclude:: snippets.py
279-
:start-after: [START bigtable_instance_admin_client]
280-
:end-before: [END bigtable_instance_admin_client]
279+
:start-after: [START bigtable_api_instance_admin_client]
280+
:end-before: [END bigtable_api_instance_admin_client]
281281
:dedent: 4
282282
283283
:rtype: :class:`.bigtable_admin_pb2.BigtableInstanceAdmin`
@@ -302,8 +302,8 @@ def instance(self, instance_id, display_name=None, instance_type=None, labels=No
302302
For example:
303303
304304
.. literalinclude:: snippets.py
305-
:start-after: [START bigtable_create_prod_instance]
306-
:end-before: [END bigtable_create_prod_instance]
305+
:start-after: [START bigtable_api_create_prod_instance]
306+
:end-before: [END bigtable_api_create_prod_instance]
307307
:dedent: 4
308308
309309
:type instance_id: str
@@ -352,8 +352,8 @@ def list_instances(self):
352352
For example:
353353
354354
.. literalinclude:: snippets.py
355-
:start-after: [START bigtable_list_instances]
356-
:end-before: [END bigtable_list_instances]
355+
:start-after: [START bigtable_api_list_instances]
356+
:end-before: [END bigtable_api_list_instances]
357357
:dedent: 4
358358
359359
:rtype: tuple
@@ -373,8 +373,8 @@ def list_clusters(self):
373373
For example:
374374
375375
.. literalinclude:: snippets.py
376-
:start-after: [START bigtable_list_clusters_in_project]
377-
:end-before: [END bigtable_list_clusters_in_project]
376+
:start-after: [START bigtable_api_list_clusters_in_project]
377+
:end-before: [END bigtable_api_list_clusters_in_project]
378378
:dedent: 4
379379
380380
:rtype: tuple

‎google/cloud/bigtable/cluster.py‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -97,8 +97,8 @@ def from_pb(cls, cluster_pb, instance):
9797
For example:
9898
9999
.. literalinclude:: snippets.py
100-
:start-after: [START bigtable_cluster_from_pb]
101-
:end-before: [END bigtable_cluster_from_pb]
100+
:start-after: [START bigtable_api_cluster_from_pb]
101+
:end-before: [END bigtable_api_cluster_from_pb]
102102
:dedent: 4
103103
104104
:type cluster_pb: :class:`instance_pb2.Cluster`
@@ -158,8 +158,8 @@ def name(self):
158158
For example:
159159
160160
.. literalinclude:: snippets.py
161-
:start-after: [START bigtable_cluster_name]
162-
:end-before: [END bigtable_cluster_name]
161+
:start-after: [START bigtable_api_cluster_name]
162+
:end-before: [END bigtable_api_cluster_name]
163163
:dedent: 4
164164
165165
The cluster name is of the form
@@ -180,8 +180,8 @@ def state(self):
180180
For example:
181181
182182
.. literalinclude:: snippets.py
183-
:start-after: [START bigtable_cluster_state]
184-
:end-before: [END bigtable_cluster_state]
183+
:start-after: [START bigtable_api_cluster_state]
184+
:end-before: [END bigtable_api_cluster_state]
185185
:dedent: 4
186186
187187
"""
@@ -207,8 +207,8 @@ def reload(self):
207207
For example:
208208
209209
.. literalinclude:: snippets.py
210-
:start-after: [START bigtable_reload_cluster]
211-
:end-before: [END bigtable_reload_cluster]
210+
:start-after: [START bigtable_api_reload_cluster]
211+
:end-before: [END bigtable_api_reload_cluster]
212212
:dedent: 4
213213
"""
214214
cluster_pb = self._instance._client.instance_admin_client.get_cluster(self.name)
@@ -223,8 +223,8 @@ def exists(self):
223223
For example:
224224
225225
.. literalinclude:: snippets.py
226-
:start-after: [START bigtable_check_cluster_exists]
227-
:end-before: [END bigtable_check_cluster_exists]
226+
:start-after: [START bigtable_api_check_cluster_exists]
227+
:end-before: [END bigtable_api_check_cluster_exists]
228228
:dedent: 4
229229
230230
:rtype: bool
@@ -244,8 +244,8 @@ def create(self):
244244
For example:
245245
246246
.. literalinclude:: snippets.py
247-
:start-after: [START bigtable_create_cluster]
248-
:end-before: [END bigtable_create_cluster]
247+
:start-after: [START bigtable_api_create_cluster]
248+
:end-before: [END bigtable_api_create_cluster]
249249
:dedent: 4
250250
251251
.. note::
@@ -278,8 +278,8 @@ def update(self):
278278
For example:
279279
280280
.. literalinclude:: snippets.py
281-
:start-after: [START bigtable_update_cluster]
282-
:end-before: [END bigtable_update_cluster]
281+
:start-after: [START bigtable_api_update_cluster]
282+
:end-before: [END bigtable_api_update_cluster]
283283
:dedent: 4
284284
285285
.. note::
@@ -311,8 +311,8 @@ def delete(self):
311311
For example:
312312
313313
.. literalinclude:: snippets.py
314-
:start-after: [START bigtable_delete_cluster]
315-
:end-before: [END bigtable_delete_cluster]
314+
:start-after: [START bigtable_api_delete_cluster]
315+
:end-before: [END bigtable_api_delete_cluster]
316316
:dedent: 4
317317
318318
Marks a cluster and all of its tables for permanent deletion in 7 days.

‎google/cloud/bigtable/column_family.py‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,8 @@ class MaxVersionsGCRule(GarbageCollectionRule):
4646
For example:
4747
4848
.. literalinclude:: snippets_table.py
49-
:start-after: [START bigtable_create_family_gc_max_versions]
50-
:end-before: [END bigtable_create_family_gc_max_versions]
49+
:start-after: [START bigtable_api_create_family_gc_max_versions]
50+
:end-before: [END bigtable_api_create_family_gc_max_versions]
5151
:dedent: 4
5252
5353
:type max_num_versions: int
@@ -80,8 +80,8 @@ class MaxAgeGCRule(GarbageCollectionRule):
8080
For example:
8181
8282
.. literalinclude:: snippets_table.py
83-
:start-after: [START bigtable_create_family_gc_max_age]
84-
:end-before: [END bigtable_create_family_gc_max_age]
83+
:start-after: [START bigtable_api_create_family_gc_max_age]
84+
:end-before: [END bigtable_api_create_family_gc_max_age]
8585
:dedent: 4
8686
8787
:type max_age: :class:`datetime.timedelta`
@@ -115,8 +115,8 @@ class GCRuleUnion(GarbageCollectionRule):
115115
For example:
116116
117117
.. literalinclude:: snippets_table.py
118-
:start-after: [START bigtable_create_family_gc_union]
119-
:end-before: [END bigtable_create_family_gc_union]
118+
:start-after: [START bigtable_api_create_family_gc_union]
119+
:end-before: [END bigtable_api_create_family_gc_union]
120120
:dedent: 4
121121
122122
:type rules: list
@@ -150,8 +150,8 @@ class GCRuleIntersection(GarbageCollectionRule):
150150
For example:
151151
152152
.. literalinclude:: snippets_table.py
153-
:start-after: [START bigtable_create_family_gc_intersection]
154-
:end-before: [END bigtable_create_family_gc_intersection]
153+
:start-after: [START bigtable_api_create_family_gc_intersection]
154+
:end-before: [END bigtable_api_create_family_gc_intersection]
155155
:dedent: 4
156156
157157
:type rules: list
@@ -214,8 +214,8 @@ def name(self):
214214
For example:
215215
216216
.. literalinclude:: snippets_table.py
217-
:start-after: [START bigtable_column_family_name]
218-
:end-before: [END bigtable_column_family_name]
217+
:start-after: [START bigtable_api_column_family_name]
218+
:end-before: [END bigtable_api_column_family_name]
219219
:dedent: 4
220220
221221
.. note::
@@ -261,8 +261,8 @@ def create(self):
261261
For example:
262262
263263
.. literalinclude:: snippets_table.py
264-
:start-after: [START bigtable_create_column_family]
265-
:end-before: [END bigtable_create_column_family]
264+
:start-after: [START bigtable_api_create_column_family]
265+
:end-before: [END bigtable_api_create_column_family]
266266
:dedent: 4
267267
268268
"""
@@ -284,8 +284,8 @@ def update(self):
284284
For example:
285285
286286
.. literalinclude:: snippets_table.py
287-
:start-after: [START bigtable_update_column_family]
288-
:end-before: [END bigtable_update_column_family]
287+
:start-after: [START bigtable_api_update_column_family]
288+
:end-before: [END bigtable_api_update_column_family]
289289
:dedent: 4
290290
291291
.. note::
@@ -311,8 +311,8 @@ def delete(self):
311311
For example:
312312
313313
.. literalinclude:: snippets_table.py
314-
:start-after: [START bigtable_delete_column_family]
315-
:end-before: [END bigtable_delete_column_family]
314+
:start-after: [START bigtable_api_delete_column_family]
315+
:end-before: [END bigtable_api_delete_column_family]
316316
:dedent: 4
317317
318318
"""

0 commit comments

Comments
 (0)