Skip to content

Commit

Permalink
Fix typos in docs (#159)
Browse files Browse the repository at this point in the history
Found some minor typos in docs after review.
  • Loading branch information
addisonElliott authored Nov 7, 2024
1 parent b7e759f commit 17fe0d0
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/source/background/datatypes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ int vector list
~~~~~~~~~~~~~~~~~~
:NRRD Syntax: (<i>,<i>,...,<i>) (<i>,<i>,...,<i>) ... (<i>,<i>,...,<i>)
:NRRD Example: (1,0,0) (0,1,0) none (0,0,1)
:Python Datatype: (M,N) :class:`list` of (N,) :class:`numpy.ndarray` of :class:`int`
:Python Datatype: :class:`list` of (N,) :class:`numpy.ndarray` of :class:`int`
:Python Example: [np.array([1, 0, 0]), np.array([0, 1, 0]), None, np.array([0, 0, 1])]

This datatype is similar to `int matrix`_ except instead of returning a (M,N) :class:`numpy.ndarray`, it returns a list of (N,) :class:`numpy.ndarray`. Each row is optional and designated by :code:`none` in the NRRD specification and represented as :obj:`None` in this library.
Expand All @@ -103,7 +103,7 @@ double vector list
~~~~~~~~~~~~~~~~~~
:NRRD Syntax: (<d>,<d>,...,<d>) (<d>,<d>,...,<d>) ... (<d>,<d>,...,<d>)
:NRRD Example: (2.54, 1.3, 0.0) (3.14, 0.3, 3.3) none (0.05, -12.3, -3.3)
:Python Datatype: (M,N) :class:`list` of (N,) :class:`numpy.ndarray` of :class:`float`
:Python Datatype: :class:`list` of (N,) :class:`numpy.ndarray` of :class:`float`
:Python Example: [np.array([2.54, 1.3, 0.0]), np.array([3.14, 0.3, 3.3]), None, np.array([0.0, -12.3, -3.3])]

This datatype is similar to `double matrix`_ except instead of returning a (M,N) :class:`numpy.ndarray`, it returns a list of (N,) :class:`numpy.ndarray`. Each row is optional and designated by :code:`none` in the NRRD specification and represented as :obj:`None` in this library.

0 comments on commit 17fe0d0

Please sign in to comment.