Skip to content

Commit

Permalink
Docstring fix
Browse files Browse the repository at this point in the history
  • Loading branch information
tritemio committed Dec 9, 2015
1 parent be4cb53 commit 5acee3e
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions fretbursts/burstsearch/burstsearchlib.py
Original file line number Diff line number Diff line change
Expand Up @@ -439,13 +439,13 @@ def separation(self):
def recompute_times(self, times, out=None):
"""Recomputes start, stop times using timestamps from a new array.
This method computes burst start, stop using the index of
timestamps in `bursts` and and using `times` as timestamps array.
This method computes burst start, stop using the index of timestamps
from the current object and timestamps from the passed array `times`.
This is useful, for example, when burst search is computed on a
"compacted" timestamps array (i.e. removing the gaps outside the
alternation period in usALEX experiments), and afterwards the "real"
start and stop times need to be recomputed.
start and stop times needs to be recomputed.
Arguments:
times (array): array of photon timestamps
Expand Down

0 comments on commit 5acee3e

Please sign in to comment.