Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Erik Tollerud <erik.tollerud@gmail.com>
  • Loading branch information
kecnry and eteq committed Apr 22, 2022
1 parent 616c475 commit ab64290
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions specutils/analysis/location.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ def centroid(spectrum, region):
Parameters
----------
spectrum : `~specutils.spectra.spectrum1d.Spectrum1D`
The spectrum object overwhich the centroid will be calculated. If the uncertainty
The spectrum object over which the centroid will be calculated. If the uncertainty
is populated, the returned quantity will include an uncertainty attribute with
the propagated uncertainty (in stddev).
the propagated uncertainty (as Standard Deviation-style uncertainties).
region: `~specutils.utils.SpectralRegion` or list of `~specutils.utils.SpectralRegion`
Region within the spectrum to calculate the centroid.
Expand Down Expand Up @@ -58,8 +58,8 @@ def centroid(spectrum, region):
def _centroid_single_region(spectrum, region=None):
"""
Calculate the centroid of the spectrum based on the flux in the spectrum.
The returned quantity object will have an uncertainty attribute which
will be populated if ``spectrum`` has uncertainties assigned.
The returned quantity object will have a ``.uncertainty`` attribute which
will be populated if ``spectrum`` has uncertainties assigned, or ``None`` if not.
Parameters
----------
Expand Down

0 comments on commit ab64290

Please # to comment.