Skip to content

Commit b6ea637

Browse files
committed
suggestions
1 parent dd2d5d5 commit b6ea637

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

docs/tutorial/data.rst

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ Data
55
.. rst-class:: lead
66

77
The data package provides a base class (:class:`compas.data.Data`) for all data objects in the COMPAS framework (see :ref:`Inheritance Diagrams`),
8-
the mechanism for serialisation of data to JSON format,
9-
and the base infrastructure for validation of the data of COMPAS objects in both the original Python and serialised JSON formats.
8+
the mechanism for serialization of data to JSON format,
9+
and the base infrastructure for validation of the data of COMPAS objects in both the original Python and serialized JSON formats.
1010

1111
::
1212

@@ -57,10 +57,10 @@ and, most importantly, an attribute containing the underlying data of the object
5757
[0.0, 0.0, 0.0]
5858

5959

60-
JSON Serialisation
60+
JSON Serialization
6161
==================
6262

63-
All objects inheriting the data interface, can be serialised to a JSON string or file.
63+
All objects inheriting the data interface, can be serialized to a JSON string or file.
6464

6565
::
6666

@@ -96,7 +96,7 @@ Conversely, COMPAS data objects can be reconstructed from a compatible JSON stri
9696
>>> mesh.to_json('mesh.json')
9797
>>> other = Mesh.from_json('mesh.json')
9898

99-
The serialisation mechanism applies recursively to nested structures of objects as well.
99+
The serialization mechanism applies recursively to nested structures of objects as well.
100100

101101
::
102102

@@ -123,7 +123,7 @@ The serialisation mechanism applies recursively to nested structures of objects
123123
Working Sessions
124124
================
125125

126-
One of the most useful features of the serialisation meshanisms provided by the data package is the ability to store and load entire COMPAS working sessions.
126+
One of the most useful features of the serialization meshanisms provided by the data package is the ability to store and load entire COMPAS working sessions.
127127

128128
.. code-block:: python
129129
@@ -156,7 +156,7 @@ One of the most useful features of the serialisation meshanisms provided by the
156156
157157
Note that if you are working in Python 3.6 or higher, you could add some type information to script B
158158
such that your editor knows what kind of objects have been loaded,
159-
which with help with intellisense and code completion.
159+
which will help with IntelliSense and code completion.
160160

161161
.. code-block:: python
162162
@@ -176,7 +176,7 @@ Validation
176176
==========
177177

178178
A somewhat experimental feature of the data package is data validation.
179-
The base data class defines two unimplemented attributes :attr:`compas.data.Data.JSONSCHEMA` and :attr:`compas.data.Data.JSONSCHEMA`.
179+
The base data class defines two unimplemented attributes :attr:`compas.data.Data.JSONSCHEMA` and :attr:`compas.data.Data.DATASCHEMA`.
180180
The former is meant to define the name of the json schema in the ``schema`` folder of :mod:`compas.data`,
181181
and the latter a Python schema using :mod:`schema.Schema`.
182182

@@ -245,8 +245,8 @@ GH Components
245245

246246
*Coming soon...*
247247

248-
Inherticance Diagrams
249-
=====================
248+
Inheritance Diagrams
249+
====================
250250

251251
.. currentmodule:: compas.geometry
252252

0 commit comments

Comments
 (0)