[docs] fixes as suggested by code review

Author: jgrewe

docs/source/faq.rst

@@ -14,9 +14,9 @@ Q: What does this error mean? “Cannot open a nonexistent file in ReadOnly mode
 -------------------------------------------------------------------------------
 
 Arises when the provided file path is invalid and you try to open it
-with the nix::FileMode::ReadOnly mode. Solution: provide the path to an
-existing file to be opened in ``nix::ReadOnly`` mode or use the
-``nix::FileMode::ReadWrite`` or ``nix::FileMode::Overwrite`` flag to
+with the nixio.FileMode.ReadOnly mode. Solution: provide the path to an
+existing file to be opened in ``nixio.FileMode.ReadOnly`` mode or use the
+``nixio.FileMode.ReadWrite`` or ``nixio.FileMode.Overwrite`` flag to
 create a new one.
 
 Q: Is it ok to use non-SI units?

docs/source/image_data.rst

@@ -33,17 +33,10 @@ One key feature of the nix-model is its ability to annotate, or "tag", points or
 Tagging a single point or region
 --------------------------------
 
-Single points of regions-of-interest are annotated using a **Tag**
-object. The Tag contains the start *position* and, optional, the
-*extent* of the point or region. The link to the data is established
-by adding the **DataArray** that contains the data to the list of
-references. It is important to note that *position* and *extent* are
-arrays with the length matching the dimensionality of the referenced
-data. The same Tag can be applied to many references as long as
-*position* and *extent* can be applied to these.
+Single points of regions-of-interest are annotated using a **Tag** object. The Tag contains the start *position* and, optional, the *extent* of the point or region. The link to the data is established by adding the **DataArray** that contains the data to the list of references. It is important to note that *position* and *extent* are arrays with the length matching the dimensionality of the referenced data. The same Tag can be applied to many references as long as *position* and *extent* can be applied to these.
 
 .. literalinclude:: examples/singleROI.py
-    :lines: 80-84
+    :lines: 77-81
     :caption: A *Tag* is used to tag a a single region of interest. Most image data is 3-D with the third dimension representing the color channels (:download:`singleROI.py <examples/singleROI.py>`).
 
 .. image:: images/single_roi.png

docs/source/news.rst

@@ -50,7 +50,7 @@ Pass ``quiet=False`` in order to get some feedback on what the tool did. **Note:
 Model changes
 #############
 
-* the metadata model was simplified to reflect the changes introduced to the underlying **odml** data model. Accordingly the *Value* entity does no longer exist. New versions of the library can read but not write old data. Experience showed that almost all use cases stored single Values in a *Property*. The overhead (code and also file size) of keeping each value in a separate Entitiy is not justified. The *Property* now keeps all information that was Value related, such as the uncertainty. If you want to store multiple values in a property this is still possible but they have to have the same data type. (see :ref:`Annotations with arbitrary metadata` for more information).
+* the metadata model was simplified to reflect the changes introduced to the underlying **odml** data model. Accordingly the *Value* entity does no longer exist. New versions of the library can read but not write old data. Experience showed that almost all use cases stored single Values in a *Property*. The overhead (code and also file size) of keeping each value in a separate Entity is not justified. The *Property* now keeps all information that was Value related, such as the uncertainty. If you want to store multiple values in a property this is still possible but they have to have the same data type. (see :ref:`Annotations with arbitrary metadata` for more information).
 * New *DataFrame* entity that stores tabular data. Each column has a name, unit, and data type. (see :ref:`The DataFrame` for more information).
 * *Tags* and *MultiTags* can link to DataFrames as features.
 * *RangeDimensions* ticks can now be stored within the dimension descriptor, or in linked DataArrays or DataFrames. Ticks must still be one-dimensional (see :ref:`RangeDimension` for more information).

docs/source/storing_data.rst

@@ -109,9 +109,9 @@ Data is read from a DataArray by accessing it in numpy style.
 
 .. code-block:: python
 
-   data_array = block.create_data_array("test data", "test", data=np.random.randn(100))
+   array = block.create_data_array("test data", "test", data=np.random.randn(100))
    print(array.shape)
-   data_array.append(np.ones(100))
+   array.append(np.ones(100))
    print(array.shape)