Skip to content

Commit

Permalink
Fix typos
Browse files Browse the repository at this point in the history
  • Loading branch information
ericpre committed Nov 2, 2021
1 parent a5dbcff commit a8ca219
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 6 deletions.
6 changes: 3 additions & 3 deletions doc/user_guide/signal.rst
Original file line number Diff line number Diff line change
Expand Up @@ -303,14 +303,14 @@ Note that the array shape is (2, ):
Numpy ragged array must have python ``object`` type to allow the variable length of
the nested sequences - here ``[1, 2, 3]`` and ``[1]``. As explained in
`NEP-34 <https://numpy.org/neps/nep-0034-infer-dtype-is-object.html>`_,
``dtype=object`` needs to be specify when creating the array to avoid ambiguity
``dtype=object`` needs to be specified when creating the array to avoid ambiguity
about the shape of the array.

HyperSpy supports the use of ragged array with the following conditions:

- The signal must be explicitely define as being ``ragged``, either when creating
the signal or by changing the ragged attribute of the signal.
- The signal dimension the variable length dimension
the signal or by changing the ragged attribute of the signal
- The signal dimension is the variable length dimension of the array
- The ``isig`` syntax is not supported
- Signal with ragged array can't be transposed
- Signal with ragged array can't be plotted
Expand Down
7 changes: 4 additions & 3 deletions hyperspy/signal.py
Original file line number Diff line number Diff line change
Expand Up @@ -2168,7 +2168,7 @@ class for more details).
ragged : bool or None, optional
Define whether the signal is ragged or not. Overwrite the
``ragged`` value in the ``attributes`` dictionary. If None, it does
nothing. Default is None
nothing. Default is None.
"""
# the 'full_initialisation' keyword is private API to be used by the
Expand Down Expand Up @@ -2431,8 +2431,9 @@ def ragged(self, value):
if self._lazy:
raise NotImplementedError(
"Conversion of a lazy ragged signal to its non-ragged "
"counterpar is not supported. Make the required non-ragged "
"dask array manually and make a new lazy signal."
"counterpart is not supported. Make the required "
"non-ragged dask array manually and make a new lazy "
"signal."
)

error = "The signal can't be converted to a non-ragged signal."
Expand Down

0 comments on commit a8ca219

Please sign in to comment.