Skip to content

Commit 92e73c4

Browse files
HemangChothanitseaver
HemangChothani
and
tseaver
authored
docs: remove indent from snippet code blocks (#49)
Co-authored-by: Tres Seaver <tseaver@palladion.com>
1 parent 86172f4 commit 92e73c4

File tree

11 files changed

+100
-6
lines changed

11 files changed

+100
-6
lines changed

‎packages/google-cloud-bigtable/google/cloud/bigtable/app_profile.py‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,7 @@ def name(self):
9595
.. literalinclude:: snippets.py
9696
:start-after: [START bigtable_app_profile_name]
9797
:end-before: [END bigtable_app_profile_name]
98+
:dedent: 4
9899
99100
The AppProfile name is of the form
100101
``"projects/../instances/../app_profile/{app_profile_id}"``
@@ -238,6 +239,7 @@ def reload(self):
238239
.. literalinclude:: snippets.py
239240
:start-after: [START bigtable_reload_app_profile]
240241
:end-before: [END bigtable_reload_app_profile]
242+
:dedent: 4
241243
"""
242244

243245
app_profile_pb = self.instance_admin_client.get_app_profile(self.name)
@@ -254,6 +256,7 @@ def exists(self):
254256
.. literalinclude:: snippets.py
255257
:start-after: [START bigtable_app_profile_exists]
256258
:end-before: [END bigtable_app_profile_exists]
259+
:dedent: 4
257260
258261
:rtype: bool
259262
:returns: True if the AppProfile exists, else False.
@@ -280,6 +283,7 @@ def create(self, ignore_warnings=None):
280283
.. literalinclude:: snippets.py
281284
:start-after: [START bigtable_create_app_profile]
282285
:end-before: [END bigtable_create_app_profile]
286+
:dedent: 4
283287
284288
:type: ignore_warnings: bool
285289
:param: ignore_warnings: (Optional) If true, ignore safety checks when
@@ -311,6 +315,7 @@ def update(self, ignore_warnings=None):
311315
.. literalinclude:: snippets.py
312316
:start-after: [START bigtable_update_app_profile]
313317
:end-before: [END bigtable_update_app_profile]
318+
:dedent: 4
314319
"""
315320
update_mask_pb = field_mask_pb2.FieldMask()
316321

@@ -336,6 +341,7 @@ def delete(self, ignore_warnings=None):
336341
.. literalinclude:: snippets.py
337342
:start-after: [START bigtable_delete_app_profile]
338343
:end-before: [END bigtable_delete_app_profile]
344+
:dedent: 4
339345
340346
:type: ignore_warnings: bool
341347
:param: ignore_warnings: If true, ignore safety checks when deleting

‎packages/google-cloud-bigtable/google/cloud/bigtable/batcher.py‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,7 @@ def mutate(self, row):
7373
.. literalinclude:: snippets.py
7474
:start-after: [START bigtable_batcher_mutate]
7575
:end-before: [END bigtable_batcher_mutate]
76+
:dedent: 4
7677
7778
:type row: class
7879
:param row: class:`~google.cloud.bigtable.row.DirectRow`.
@@ -112,6 +113,7 @@ def mutate_rows(self, rows):
112113
.. literalinclude:: snippets.py
113114
:start-after: [START bigtable_batcher_mutate_rows]
114115
:end-before: [END bigtable_batcher_mutate_rows]
116+
:dedent: 4
115117
116118
:type rows: list:[`~google.cloud.bigtable.row.DirectRow`]
117119
:param rows: list:[`~google.cloud.bigtable.row.DirectRow`].
@@ -134,6 +136,7 @@ def flush(self):
134136
.. literalinclude:: snippets.py
135137
:start-after: [START bigtable_batcher_flush]
136138
:end-before: [END bigtable_batcher_flush]
139+
:dedent: 4
137140
138141
"""
139142
if len(self.rows) != 0:

‎packages/google-cloud-bigtable/google/cloud/bigtable/client.py‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -206,6 +206,7 @@ def project_path(self):
206206
.. literalinclude:: snippets.py
207207
:start-after: [START bigtable_project_path]
208208
:end-before: [END bigtable_project_path]
209+
:dedent: 4
209210
210211
The project name is of the form
211212
@@ -225,6 +226,7 @@ def table_data_client(self):
225226
.. literalinclude:: snippets.py
226227
:start-after: [START bigtable_table_data_client]
227228
:end-before: [END bigtable_table_data_client]
229+
:dedent: 4
228230
229231
:rtype: :class:`.bigtable_v2.BigtableClient`
230232
:returns: A BigtableClient object.
@@ -245,6 +247,7 @@ def table_admin_client(self):
245247
.. literalinclude:: snippets.py
246248
:start-after: [START bigtable_table_admin_client]
247249
:end-before: [END bigtable_table_admin_client]
250+
:dedent: 4
248251
249252
:rtype: :class:`.bigtable_admin_pb2.BigtableTableAdmin`
250253
:returns: A BigtableTableAdmin instance.
@@ -271,6 +274,7 @@ def instance_admin_client(self):
271274
.. literalinclude:: snippets.py
272275
:start-after: [START bigtable_instance_admin_client]
273276
:end-before: [END bigtable_instance_admin_client]
277+
:dedent: 4
274278
275279
:rtype: :class:`.bigtable_admin_pb2.BigtableInstanceAdmin`
276280
:returns: A BigtableInstanceAdmin instance.
@@ -296,6 +300,7 @@ def instance(self, instance_id, display_name=None, instance_type=None, labels=No
296300
.. literalinclude:: snippets.py
297301
:start-after: [START bigtable_create_prod_instance]
298302
:end-before: [END bigtable_create_prod_instance]
303+
:dedent: 4
299304
300305
:type instance_id: str
301306
:param instance_id: The ID of the instance.
@@ -345,6 +350,7 @@ def list_instances(self):
345350
.. literalinclude:: snippets.py
346351
:start-after: [START bigtable_list_instances]
347352
:end-before: [END bigtable_list_instances]
353+
:dedent: 4
348354
349355
:rtype: tuple
350356
:returns:
@@ -365,6 +371,7 @@ def list_clusters(self):
365371
.. literalinclude:: snippets.py
366372
:start-after: [START bigtable_list_clusters_in_project]
367373
:end-before: [END bigtable_list_clusters_in_project]
374+
:dedent: 4
368375
369376
:rtype: tuple
370377
:returns:

‎packages/google-cloud-bigtable/google/cloud/bigtable/cluster.py‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,7 @@ def from_pb(cls, cluster_pb, instance):
9999
.. literalinclude:: snippets.py
100100
:start-after: [START bigtable_cluster_from_pb]
101101
:end-before: [END bigtable_cluster_from_pb]
102+
:dedent: 4
102103
103104
:type cluster_pb: :class:`instance_pb2.Cluster`
104105
:param cluster_pb: An instance protobuf object.
@@ -159,6 +160,7 @@ def name(self):
159160
.. literalinclude:: snippets.py
160161
:start-after: [START bigtable_cluster_name]
161162
:end-before: [END bigtable_cluster_name]
163+
:dedent: 4
162164
163165
The cluster name is of the form
164166
@@ -180,6 +182,7 @@ def state(self):
180182
.. literalinclude:: snippets.py
181183
:start-after: [START bigtable_cluster_state]
182184
:end-before: [END bigtable_cluster_state]
185+
:dedent: 4
183186
184187
"""
185188
return self._state
@@ -206,6 +209,7 @@ def reload(self):
206209
.. literalinclude:: snippets.py
207210
:start-after: [START bigtable_reload_cluster]
208211
:end-before: [END bigtable_reload_cluster]
212+
:dedent: 4
209213
"""
210214
cluster_pb = self._instance._client.instance_admin_client.get_cluster(self.name)
211215

@@ -221,6 +225,7 @@ def exists(self):
221225
.. literalinclude:: snippets.py
222226
:start-after: [START bigtable_check_cluster_exists]
223227
:end-before: [END bigtable_check_cluster_exists]
228+
:dedent: 4
224229
225230
:rtype: bool
226231
:returns: True if the table exists, else False.
@@ -241,6 +246,7 @@ def create(self):
241246
.. literalinclude:: snippets.py
242247
:start-after: [START bigtable_create_cluster]
243248
:end-before: [END bigtable_create_cluster]
249+
:dedent: 4
244250
245251
.. note::
246252
@@ -274,6 +280,7 @@ def update(self):
274280
.. literalinclude:: snippets.py
275281
:start-after: [START bigtable_update_cluster]
276282
:end-before: [END bigtable_update_cluster]
283+
:dedent: 4
277284
278285
.. note::
279286
@@ -306,6 +313,7 @@ def delete(self):
306313
.. literalinclude:: snippets.py
307314
:start-after: [START bigtable_delete_cluster]
308315
:end-before: [END bigtable_delete_cluster]
316+
:dedent: 4
309317
310318
Marks a cluster and all of its tables for permanent deletion in 7 days.
311319

‎packages/google-cloud-bigtable/google/cloud/bigtable/column_family.py‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@ class MaxVersionsGCRule(GarbageCollectionRule):
4848
.. literalinclude:: snippets_table.py
4949
:start-after: [START bigtable_create_family_gc_max_versions]
5050
:end-before: [END bigtable_create_family_gc_max_versions]
51+
:dedent: 4
5152
5253
:type max_num_versions: int
5354
:param max_num_versions: The maximum number of versions
@@ -81,6 +82,7 @@ class MaxAgeGCRule(GarbageCollectionRule):
8182
.. literalinclude:: snippets_table.py
8283
:start-after: [START bigtable_create_family_gc_max_age]
8384
:end-before: [END bigtable_create_family_gc_max_age]
85+
:dedent: 4
8486
8587
:type max_age: :class:`datetime.timedelta`
8688
:param max_age: The maximum age allowed for a cell in the table.
@@ -115,6 +117,7 @@ class GCRuleUnion(GarbageCollectionRule):
115117
.. literalinclude:: snippets_table.py
116118
:start-after: [START bigtable_create_family_gc_union]
117119
:end-before: [END bigtable_create_family_gc_union]
120+
:dedent: 4
118121
119122
:type rules: list
120123
:param rules: List of :class:`GarbageCollectionRule`.
@@ -149,6 +152,7 @@ class GCRuleIntersection(GarbageCollectionRule):
149152
.. literalinclude:: snippets_table.py
150153
:start-after: [START bigtable_create_family_gc_intersection]
151154
:end-before: [END bigtable_create_family_gc_intersection]
155+
:dedent: 4
152156
153157
:type rules: list
154158
:param rules: List of :class:`GarbageCollectionRule`.
@@ -212,6 +216,7 @@ def name(self):
212216
.. literalinclude:: snippets_table.py
213217
:start-after: [START bigtable_column_family_name]
214218
:end-before: [END bigtable_column_family_name]
219+
:dedent: 4
215220
216221
.. note::
217222
@@ -258,6 +263,7 @@ def create(self):
258263
.. literalinclude:: snippets_table.py
259264
:start-after: [START bigtable_create_column_family]
260265
:end-before: [END bigtable_create_column_family]
266+
:dedent: 4
261267
262268
"""
263269
column_family = self.to_pb()
@@ -280,6 +286,7 @@ def update(self):
280286
.. literalinclude:: snippets_table.py
281287
:start-after: [START bigtable_update_column_family]
282288
:end-before: [END bigtable_update_column_family]
289+
:dedent: 4
283290
284291
.. note::
285292
@@ -306,6 +313,7 @@ def delete(self):
306313
.. literalinclude:: snippets_table.py
307314
:start-after: [START bigtable_delete_column_family]
308315
:end-before: [END bigtable_delete_column_family]
316+
:dedent: 4
309317
310318
"""
311319
modification = table_admin_v2_pb2.ModifyColumnFamiliesRequest.Modification(

‎packages/google-cloud-bigtable/google/cloud/bigtable/instance.py‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,7 @@ def from_pb(cls, instance_pb, client):
134134
.. literalinclude:: snippets.py
135135
:start-after: [START bigtable_instance_from_pb]
136136
:end-before: [END bigtable_instance_from_pb]
137+
:dedent: 4
137138
138139
:type instance_pb: :class:`instance_pb2.Instance`
139140
:param instance_pb: An instance protobuf object.
@@ -178,6 +179,7 @@ def name(self):
178179
.. literalinclude:: snippets.py
179180
:start-after: [START bigtable_instance_name]
180181
:end-before: [END bigtable_instance_name]
182+
:dedent: 4
181183
182184
The instance name is of the form
183185
@@ -199,6 +201,7 @@ def state(self):
199201
.. literalinclude:: snippets.py
200202
:start-after: [START bigtable_instance_state]
201203
:end-before: [END bigtable_instance_state]
204+
:dedent: 4
202205
203206
"""
204207
return self._state
@@ -231,6 +234,7 @@ def create(
231234
.. literalinclude:: snippets.py
232235
:start-after: [START bigtable_create_prod_instance]
233236
:end-before: [END bigtable_create_prod_instance]
237+
:dedent: 4
234238
235239
.. note::
236240
@@ -331,6 +335,7 @@ def exists(self):
331335
.. literalinclude:: snippets.py
332336
:start-after: [START bigtable_check_instance_exists]
333337
:end-before: [END bigtable_check_instance_exists]
338+
:dedent: 4
334339
335340
:rtype: bool
336341
:returns: True if the table exists, else False.
@@ -350,6 +355,7 @@ def reload(self):
350355
.. literalinclude:: snippets.py
351356
:start-after: [START bigtable_reload_instance]
352357
:end-before: [END bigtable_reload_instance]
358+
:dedent: 4
353359
"""
354360
instance_pb = self._client.instance_admin_client.get_instance(self.name)
355361

@@ -365,6 +371,7 @@ def update(self):
365371
.. literalinclude:: snippets.py
366372
:start-after: [START bigtable_update_instance]
367373
:end-before: [END bigtable_update_instance]
374+
:dedent: 4
368375
369376
.. note::
370377
@@ -411,6 +418,7 @@ def delete(self):
411418
.. literalinclude:: snippets.py
412419
:start-after: [START bigtable_delete_instance]
413420
:end-before: [END bigtable_delete_instance]
421+
:dedent: 4
414422
415423
Marks an instance and all of its tables for permanent deletion
416424
in 7 days.
@@ -441,6 +449,7 @@ def get_iam_policy(self, requested_policy_version=None):
441449
.. literalinclude:: snippets.py
442450
:start-after: [START bigtable_get_iam_policy]
443451
:end-before: [END bigtable_get_iam_policy]
452+
:dedent: 4
444453
445454
:type requested_policy_version: int or ``NoneType``
446455
:param requested_policy_version: Optional. The version of IAM policies to request.
@@ -480,6 +489,7 @@ class `google.cloud.bigtable.policy.Policy`
480489
.. literalinclude:: snippets.py
481490
:start-after: [START bigtable_set_iam_policy]
482491
:end-before: [END bigtable_set_iam_policy]
492+
:dedent: 4
483493
484494
:type policy: :class:`google.cloud.bigtable.policy.Policy`
485495
:param policy: A new IAM policy to replace the current IAM policy
@@ -503,6 +513,7 @@ def test_iam_permissions(self, permissions):
503513
.. literalinclude:: snippets.py
504514
:start-after: [START bigtable_test_iam_permissions]
505515
:end-before: [END bigtable_test_iam_permissions]
516+
:dedent: 4
506517
507518
:type permissions: list
508519
:param permissions: The set of permissions to check for
@@ -532,6 +543,7 @@ def cluster(
532543
.. literalinclude:: snippets.py
533544
:start-after: [START bigtable_create_cluster]
534545
:end-before: [END bigtable_create_cluster]
546+
:dedent: 4
535547
536548
:type cluster_id: str
537549
:param cluster_id: The ID of the cluster.
@@ -575,6 +587,7 @@ def list_clusters(self):
575587
.. literalinclude:: snippets.py
576588
:start-after: [START bigtable_list_clusters_on_instance]
577589
:end-before: [END bigtable_list_clusters_on_instance]
590+
:dedent: 4
578591
579592
:rtype: tuple
580593
:returns:
@@ -595,6 +608,7 @@ def table(self, table_id, mutation_timeout=None, app_profile_id=None):
595608
.. literalinclude:: snippets.py
596609
:start-after: [START bigtable_create_table]
597610
:end-before: [END bigtable_create_table]
611+
:dedent: 4
598612
599613
:type table_id: str
600614
:param table_id: The ID of the table.
@@ -620,6 +634,7 @@ def list_tables(self):
620634
.. literalinclude:: snippets.py
621635
:start-after: [START bigtable_list_tables]
622636
:end-before: [END bigtable_list_tables]
637+
:dedent: 4
623638
624639
:rtype: list of :class:`Table <google.cloud.bigtable.table.Table>`
625640
:returns: The list of tables owned by the instance.
@@ -655,6 +670,7 @@ def app_profile(
655670
.. literalinclude:: snippets.py
656671
:start-after: [START bigtable_create_app_profile]
657672
:end-before: [END bigtable_create_app_profile]
673+
:dedent: 4
658674
659675
:type app_profile_id: str
660676
:param app_profile_id: The ID of the AppProfile. Must be of the form
@@ -701,6 +717,7 @@ def list_app_profiles(self):
701717
.. literalinclude:: snippets.py
702718
:start-after: [START bigtable_list_app_profiles]
703719
:end-before: [END bigtable_list_app_profiles]
720+
:dedent: 4
704721
705722
:rtype: :list:[`~google.cloud.bigtable.app_profile.AppProfile`]
706723
:returns: A :list:[`~google.cloud.bigtable.app_profile.AppProfile`].

0 commit comments

Comments
 (0)