Skip to content

Commit

Permalink
Update docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
francisco-dlp committed Jun 27, 2024
1 parent 72cc079 commit 2328ad3
Showing 1 changed file with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions hyperspy/axes.py
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
round_half_towards_zero,
)
from hyperspy.misc.math_tools import isfloat
from hyperspy.misc.utils import isiterable, ordinal, TupleSA
from hyperspy.misc.utils import TupleSA, isiterable, ordinal
from hyperspy.ui_registry import add_gui_method, get_gui

_logger = logging.getLogger(__name__)
Expand Down Expand Up @@ -2120,12 +2120,20 @@ def _update_attributes(self):

@property
def signal_axes(self):
"""The signal axes as a tuple."""
"""The signal axes as a TupleSA.
A TupleSA object is a tuple with a `set` method
to easily set the attributes of its items.
"""
return TupleSA(self._signal_axes)

@property
def navigation_axes(self):
"""The navigation axes as a tuple."""
"""The navigation axes as a TupleSA.
A TupleSA object is a tuple with a `set` method
to easily set the attributes of its items.
"""
return TupleSA(self._navigation_axes)

@property
Expand Down Expand Up @@ -2580,4 +2588,3 @@ def _parse_axis_attribute(value):
return None
else:
return value

0 comments on commit 2328ad3

Please sign in to comment.