Skip to content

Commit

Permalink
Fix more docstrings [docs only]
Browse files Browse the repository at this point in the history
  • Loading branch information
matteobachetti committed Nov 14, 2023
1 parent f28c8ce commit d32be51
Showing 1 changed file with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions stingray/crossspectrum.py
Original file line number Diff line number Diff line change
Expand Up @@ -1925,7 +1925,7 @@ class DynamicalCrossspectrum(AveragedCrossspectrum):
dt: float
Compulsory for input :class:`stingray.EventList` data. The time resolution of the
lightcurve that is created internally from the input event lists. Drives the
lightcurve that is created internally from the input event lists. Drives the
Nyquist frequency.
Attributes
Expand Down Expand Up @@ -2014,9 +2014,9 @@ def rebin_frequency(self, df_new, method="sum"):
Rebinning is an in-place operation, i.e. will replace the existing
``dyn_ps`` attribute.
While the new resolution need not be an integer multiple of the
previous frequency resolution, be aware that if it is not, the last
bin will be cut off by the fraction left over by the integer division.
While the new resolution does not need to be an integer of the previous frequency
resolution, be aware that if this is the case, the last frequency bin will be cut
off by the fraction left over by the integer division
Parameters
----------
Expand Down Expand Up @@ -2045,9 +2045,10 @@ def rebin_frequency(self, df_new, method="sum"):
def rebin_time(self, dt_new, method="sum"):
"""
Rebin the Dynamic Power Spectrum to a new time resolution.
While the new resolution need not be an integer multiple of the
previous time resolution, be aware that if it is not, the last bin
will be cut off by the fraction left over by the integer division.
While the new resolution does not need to be an integer of the previous time
resolution, be aware that if this is the case, the last frequency bin will be cut
off by the fraction left over by the integer division
Parameters
----------
Expand All @@ -2066,7 +2067,7 @@ def rebin_time(self, dt_new, method="sum"):
Time axis with new rebinned time resolution.
dynspec_new: numpy.ndarray
New rebinned Dynamical Power Spectrum.
New rebinned Dynamical Cross Spectrum.
"""
if dt_new < self.dt:
raise ValueError("New time resolution must be larger than old time resolution!")
Expand Down

0 comments on commit d32be51

Please sign in to comment.