Skip to content

Commit b6a7e4b

Browse files
committed
Fixed grammar in comments and docs.
Summary of edits: * "a instance" -> "an instance" consistency (some are correct, some not) * removed extraneous words, added missing words in sentences * minor grammatical edits for readability
1 parent a10cf56 commit b6a7e4b

File tree

9 files changed

+22
-22
lines changed

9 files changed

+22
-22
lines changed

bigtable/google/cloud/bigtable/client.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
In the hierarchy of API concepts
2020
2121
* a :class:`Client` owns an :class:`.Instance`
22-
* a :class:`.Instance` owns a :class:`~google.cloud.bigtable.table.Table`
22+
* an :class:`.Instance` owns a :class:`~google.cloud.bigtable.table.Table`
2323
* a :class:`~google.cloud.bigtable.table.Table` owns a
2424
:class:`~.column_family.ColumnFamily`
2525
* a :class:`~google.cloud.bigtable.table.Table` owns a :class:`~.row.Row`

bigtable/google/cloud/bigtable/instance.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
# See the License for the specific language governing permissions and
1313
# limitations under the License.
1414

15-
"""User friendly container for Google Cloud Bigtable Instance."""
15+
"""User-friendly container for Google Cloud Bigtable Instance."""
1616

1717

1818
import re
@@ -67,7 +67,7 @@ def _prepare_create_request(instance):
6767
class Instance(object):
6868
"""Representation of a Google Cloud Bigtable Instance.
6969
70-
We can use a :class:`Instance` to:
70+
We can use an :class:`Instance` to:
7171
7272
* :meth:`reload` itself
7373
* :meth:`create` itself
@@ -123,10 +123,10 @@ def _update_from_pb(self, instance_pb):
123123

124124
@classmethod
125125
def from_pb(cls, instance_pb, client):
126-
"""Creates a instance instance from a protobuf.
126+
"""Creates an instance instance from a protobuf.
127127
128128
:type instance_pb: :class:`instance_pb2.Instance`
129-
:param instance_pb: A instance protobuf object.
129+
:param instance_pb: An instance protobuf object.
130130
131131
:type client: :class:`Client <google.cloud.bigtable.client.Client>`
132132
:param client: The client that owns the instance.
@@ -261,7 +261,7 @@ def update(self):
261261
def delete(self):
262262
"""Delete this instance.
263263
264-
Marks a instance and all of its tables for permanent deletion
264+
Marks an instance and all of its tables for permanent deletion
265265
in 7 days.
266266
267267
Immediately upon completion of the request:

bigtable/google/cloud/bigtable/row.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
# See the License for the specific language governing permissions and
1313
# limitations under the License.
1414

15-
"""User friendly container for Google Cloud Bigtable Row."""
15+
"""User-friendly container for Google Cloud Bigtable Row."""
1616

1717

1818
import struct
@@ -657,7 +657,7 @@ class AppendRow(Row):
657657
The first works by appending bytes and the second by incrementing an
658658
integer (stored in the cell as 8 bytes). In either case, if the
659659
cell is empty, assumes the default empty value (empty string for
660-
bytes or and 0 for integer).
660+
bytes or 0 for integer).
661661
662662
:type row_key: bytes
663663
:param row_key: The key for the current row.

docs/bigtable-client-intro.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ API requests, you'll need to pass the ``admin`` argument:
6565
Read-Only Mode
6666
--------------
6767

68-
If on the other hand, you only have (or want) read access to the data,
68+
If, on the other hand, you only have (or want) read access to the data,
6969
you can pass the ``read_only`` argument:
7070

7171
.. code:: python
@@ -81,7 +81,7 @@ Next Step
8181
---------
8282

8383
After a :class:`Client <google.cloud.bigtable.client.Client>`, the next highest-level
84-
object is a :class:`Instance <google.cloud.bigtable.instance.Instance>`. You'll need
84+
object is an :class:`Instance <google.cloud.bigtable.instance.Instance>`. You'll need
8585
one before you can interact with tables or data.
8686

8787
Head next to learn about the :doc:`bigtable-instance-api`.

docs/bigtable-data-api.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Cells vs. Columns vs. Column Families
1717
* Each cell lies in a column (**not** a column family). A column is really
1818
just a more **specific** modifier within a column family. A column
1919
can be present in every column family, in only one or anywhere in between.
20-
* Within a column family there can be many columns. For example within
20+
* Within a column family there can be many columns. For example, within
2121
the column family ``foo`` we could have columns ``bar`` and ``baz``.
2222
These would typically be represented as ``foo:bar`` and ``foo:baz``.
2323

@@ -106,8 +106,8 @@ Direct mutations can be added via one of four methods
106106
If the ``timestamp`` is omitted, the current time on the Google Cloud
107107
Bigtable server will be used when the cell is stored.
108108

109-
The value can either by bytes or an integer (which will be converted to
110-
bytes as a signed 64-bit integer).
109+
The value can either be bytes or an integer, which will be converted to
110+
bytes as a signed 64-bit integer.
111111

112112
* :meth:`delete_cell() <google.cloud.bigtable.row.DirectRow.delete_cell>` deletes
113113
all cells (i.e. for all timestamps) in a given column
@@ -129,7 +129,7 @@ Direct mutations can be added via one of four methods
129129
130130
* :meth:`delete_cells() <google.cloud.bigtable.row.DirectRow.delete_cells>` does
131131
the same thing as
132-
:meth:`delete_cell() <google.cloud.bigtable.row.DirectRow.delete_cell>`
132+
:meth:`delete_cell() <google.cloud.bigtable.row.DirectRow.delete_cell>`,
133133
but accepts a list of columns in a column family rather than a single one.
134134

135135
.. code:: python

docs/bigtable-instance-api.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ If you want a comprehensive list of all existing instances, make a
1818
Instance Factory
1919
----------------
2020

21-
To create a :class:`Instance <google.cloud.bigtable.instance.Instance>` object:
21+
To create an :class:`Instance <google.cloud.bigtable.instance.Instance>` object:
2222

2323
.. code:: python
2424
@@ -57,7 +57,7 @@ Check on Current Operation
5757

5858
.. note::
5959

60-
When modifying a instance (via a `CreateInstance`_ request), the Bigtable
60+
When modifying an instance (via a `CreateInstance`_ request), the Bigtable
6161
API will return a `long-running operation`_ and a corresponding
6262
:class:`Operation <google.cloud.bigtable.instance.Operation>` object
6363
will be returned by

docs/bigtable-row-filters.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ It is possible to use a
66
when adding mutations to a
77
:class:`ConditionalRow <google.cloud.bigtable.row.ConditionalRow>` and when
88
reading row data with :meth:`read_row() <google.cloud.bigtable.table.Table.read_row>`
9-
:meth:`read_rows() <google.cloud.bigtable.table.Table.read_rows>`.
9+
or :meth:`read_rows() <google.cloud.bigtable.table.Table.read_rows>`.
1010

1111
As laid out in the `RowFilter definition`_, the following basic filters
1212
are provided:

docs/bigtable-table-api.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Table Admin API
22
===============
33

4-
After creating a :class:`Instance <google.cloud.bigtable.instance.Instance>`, you can
4+
After creating an :class:`Instance <google.cloud.bigtable.instance.Instance>`, you can
55
interact with individual tables, groups of tables or column families within
66
a table.
77

@@ -42,7 +42,7 @@ with :meth:`create() <google.cloud.bigtable.table.Table.create>`:
4242
4343
table.create()
4444
45-
If you would to initially split the table into several tablets (Tablets are
45+
If you would like to initially split the table into several tablets (tablets are
4646
similar to HBase regions):
4747

4848
.. code:: python

docs/bigtable-usage.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ Get started by learning about the
1111

1212
In the hierarchy of API concepts
1313

14-
* a :class:`Client <google.cloud.bigtable.client.Client>` owns a
15-
:class:`Cluster <google.cloud.bigtable.instance.Instance`
16-
* a :class:`Cluster <google.cloud.bigtable.instance.Instance` owns a
14+
* a :class:`Client <google.cloud.bigtable.client.Client>` owns an
15+
:class:`Instance <google.cloud.bigtable.instance.Instance>`
16+
* an :class:`Instance <google.cloud.bigtable.instance.Instance>` owns a
1717
:class:`Table <google.cloud.bigtable.table.Table>`
1818
* a :class:`Table <google.cloud.bigtable.table.Table>` owns a
1919
:class:`ColumnFamily <google.cloud.bigtable.column_family.ColumnFamily>`

0 commit comments

Comments
 (0)