Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: Renaming region tags to not conflict with documentation snippets #190

Merged
merged 1 commit into from Jan 8, 2021
Merged

fix: Renaming region tags to not conflict with documentation snippets #190

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
156 changes: 78 additions & 78 deletions docs/snippets.py
View file
Open in desktop

Large diffs are not rendered by default.

224 changes: 112 additions & 112 deletions docs/snippets_table.py
View file
Open in desktop

Large diffs are not rendered by default.

24 changes: 12 additions & 12 deletions google/cloud/bigtable/app_profile.py
View file
Open in desktop
Expand Up @@ -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
Expand Down Expand Up @@ -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
"""

Expand All @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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()
Expand All @@ -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
Expand Down
12 changes: 6 additions & 6 deletions google/cloud/bigtable/batcher.py
View file
Open in desktop
Expand Up @@ -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
Expand Down Expand Up @@ -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`]
Expand All @@ -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

"""
Expand Down
28 changes: 14 additions & 14 deletions google/cloud/bigtable/client.py
View file
Open in desktop
Expand Up @@ -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
Expand All @@ -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`
Expand All @@ -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`
Expand All @@ -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`
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand Down
32 changes: 16 additions & 16 deletions google/cloud/bigtable/cluster.py
View file
Open in desktop
Expand Up @@ -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`
Expand Down Expand Up @@ -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
Expand All @@ -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

"""
Expand All @@ -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)
Expand All @@ -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
Expand All @@ -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::
Expand Down Expand Up @@ -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::
Expand Down Expand Up @@ -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.
Expand Down
32 changes: 16 additions & 16 deletions google/cloud/bigtable/column_family.py
View file
Open in desktop
Expand Up @@ -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
Expand Down Expand Up @@ -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`
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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::
Expand Down Expand Up @@ -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

"""
Expand All @@ -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::
Expand All @@ -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

"""
Expand Down