Skip to content

Fix minor grammar issues #5

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

Open
popmechanic wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix minor grammar issues #5

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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/source/api/data-structures.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ The full schema is the following:
bytes transaction_metadata = 3;
}

.. note:: The schema uses the version 3 of Protocol Buffers.
.. note:: The schema uses version 3 of Protocol Buffers.

.. _data-structures-records:

Expand Down Expand Up @@ -66,7 +66,7 @@ A record that has never been set has a ``value`` and ``version`` both equal to a
Check-only records
~~~~~~~~~~~~~~~~~~

If a record object has a null ``value`` field, the record object is called a **check-only record**, and does not cause a mutation to the record. It however expresses the requirement that the record (as represented by the ``key`` field) must have the version specified in the ``version`` field of the record object. If the versions don't match, the whole mutation fails to apply.
If a record object has a null ``value`` field, the record object is called a **check-only record**, and does not cause a mutation to the record. However, it expresses the requirement that the record (as represented by the ``key`` field) must have the version specified in the ``version`` field of the record object. If the versions don't match, the whole mutation fails to apply.

This provides a way to ensure that a given record has not been modified between the moment the transaction was created and the moment it gets validated, even if the record doesn't have to be modified.

Expand Down Expand Up @@ -108,4 +108,4 @@ A transaction is a wapper around a mutation.

* ``mutation``: The mutation applied by the transaction. It is represented as a byte string but deserialized according to the :ref:`Mutation schema <data-structures-mutation>`.
* ``timestamp``: A timestamp for the transaction.
* ``transaction_metadata``: Arbitrary metadata to be stored in the mutation. This will typically contain a digital signature of the mutation by the required parties.
* ``transaction_metadata``: Arbitrary metadata to be stored in the mutation. This will typically contain a digital signature of the mutation by the required parties.