From ea61fc2ed03e42b3ea159b7ef7886d005c90e29f Mon Sep 17 00:00:00 2001 From: Mario Mulansky Date: Tue, 3 Feb 2015 15:13:22 +0100 Subject: update docs to the structural changes --- pyspike/DiscreteFunc.py | 6 +++--- pyspike/spikes.py | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) (limited to 'pyspike') diff --git a/pyspike/DiscreteFunc.py b/pyspike/DiscreteFunc.py index 2283e03..bd13e1f 100644 --- a/pyspike/DiscreteFunc.py +++ b/pyspike/DiscreteFunc.py @@ -23,10 +23,10 @@ class DiscreteFunc(object): """ Constructs the discrete function. :param x: array of length N defining the points at which the values are - defined. + defined. :param y: array of length N degining the values at the points x. :param multiplicity: array of length N defining the multiplicity of the - values. + values. """ # convert parameters to arrays, also ensures copying self.x = np.array(x) @@ -174,7 +174,7 @@ class DiscreteFunc(object): def avrg(self, interval=None): """ Computes the average of the interval sequence: - :math:`a = 1/N sum f_n ` where N is the number of intervals. + :math:`a = 1/N sum f_n` where N is the number of intervals. :param interval: averaging interval given as a pair of floats, a sequence of pairs for averaging multiple intervals, or diff --git a/pyspike/spikes.py b/pyspike/spikes.py index 6a3353e..c7a1e40 100644 --- a/pyspike/spikes.py +++ b/pyspike/spikes.py @@ -54,7 +54,7 @@ def spike_train_from_string(s, sep=' ', is_sorted=False): :param s: the string with (ordered) spike times :param sep: The separator between the time numbers, default=' '. :param is_sorted: if True, the spike times are not sorted after loading, - if False, spike times are sorted with `np.sort` + if False, spike times are sorted with `np.sort` :returns: array of spike times """ if not(is_sorted): -- cgit v1.2.3