Skip to content

Commit

Permalink
Another take at SpectralRegion doclinks
Browse files Browse the repository at this point in the history
  • Loading branch information
dhomeier authored Feb 1, 2024
1 parent 2e357c8 commit 90f92c6
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion specutils/analysis/moment.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ def moment(spectrum, regions=None, order=0, axis=-1):
spectrum : `~specutils.spectra.spectrum1d.Spectrum1D`
The spectrum object over which the width will be calculated.
regions: `~specutils.SpectralRegion` or list of `~specutils.SpectralRegion`
regions: `~specutils.spectra.spectral_region.SpectralRegion` or list of `~specutils.spectra.spectral_region.SpectralRegion`
Region within the spectrum to calculate the gaussian sigma width. If
regions is `None`, computation is performed over entire spectrum.
Expand Down
8 changes: 4 additions & 4 deletions specutils/analysis/uncertainty.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ def snr(spectrum, region=None):
spectrum : `~specutils.spectra.spectrum1d.Spectrum1D`
The spectrum object overwhich the equivalent width will be calculated.
region: `~specutils.SpectralRegion` or list of `~specutils.SpectralRegion`
region: `~specutils.spectra.spectral_region.SpectralRegion` or list of `~specutils.spectra.spectral_region.SpectralRegion`
Region within the spectrum to calculate the SNR.
Returns
Expand Down Expand Up @@ -67,7 +67,7 @@ def _snr_single_region(spectrum, region=None):
spectrum : `~specutils.spectra.spectrum1d.Spectrum1D`
The spectrum object overwhich the equivalent width will be calculated.
region: `~specutils.SpectralRegion`
region: `~specutils.spectra.spectral_region.SpectralRegion`
Region within the spectrum to calculate the SNR.
Returns
Expand Down Expand Up @@ -109,7 +109,7 @@ def snr_derived(spectrum, region=None):
spectrum : `~specutils.spectra.spectrum1d.Spectrum1D`
The spectrum object overwhich the equivalent width will be calculated.
region: `~specutils.SpectralRegion`
region: `~specutils.spectra.spectral_region.SpectralRegion`
Region within the spectrum to calculate the SNR.
Returns
Expand Down Expand Up @@ -155,7 +155,7 @@ def _snr_derived(spectrum, region=None):
spectrum : `~specutils.spectra.spectrum1d.Spectrum1D`
The spectrum object overwhich the equivalent width will be calculated.
region: `~specutils.SpectralRegion`
region: `~specutils.spectra.spectral_region.SpectralRegion`
Region within the spectrum to calculate the SNR.
Returns
Expand Down

0 comments on commit 90f92c6

Please sign in to comment.