Skip to content

Commit

Permalink
Update docstring
Browse files Browse the repository at this point in the history
Co-authored-by: Derek Homeier <[email protected]>
  • Loading branch information
rosteen and dhomeier authored Feb 1, 2024
1 parent 2a4f39a commit eea7796
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions specutils/spectra/spectrum_mixin.py
Original file line number Diff line number Diff line change
Expand Up @@ -192,9 +192,9 @@ def with_spectral_axis_unit(self, unit, velocity_convention=None,
rest_value=None):
"""
Returns a new spectrum with a different spectral axis unit. Note that this creates a new
object using the converted spectral axis and thus drops the original WCS, if it existed.
The original WCS will be stored in the ``original_wcs`` entry of the new object's ``meta``
dictionary.
object using the converted spectral axis and thus drops the original WCS, if it existed,
replacing it with a :class:`~specutils.utils.wcs_utils.SpectralGWCS`. The original WCS
will be stored in the ``original_wcs`` entry of the new object's ``meta`` dictionary.
Parameters
----------
Expand Down

0 comments on commit eea7796

Please sign in to comment.