1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49
|
From: Gard Spreemann <gspr@nonempty.org>
Date: Tue, 3 Dec 2024 16:27:53 +0100
Subject: Use raw strings with TeX docstrings
---
pyspike/PieceWiseConstFunc.py | 2 +-
pyspike/PieceWiseLinFunc.py | 2 +-
pyspike/spike_sync.py | 2 +-
3 files changed, 3 insertions(+), 3 deletions(-)
diff --git a/pyspike/PieceWiseConstFunc.py b/pyspike/PieceWiseConstFunc.py
index 450e59a..dade4d0 100644
--- a/pyspike/PieceWiseConstFunc.py
+++ b/pyspike/PieceWiseConstFunc.py
@@ -157,7 +157,7 @@ class PieceWiseConstFunc(object):
return a
def avrg(self, interval=None):
- """ Computes the average of the piece-wise const function:
+ r""" Computes the average of the piece-wise const function:
:math:`a = 1/T \int_0^T f(x) dx` where T is the length of the interval.
:param interval: averaging interval given as a pair of floats, a
diff --git a/pyspike/PieceWiseLinFunc.py b/pyspike/PieceWiseLinFunc.py
index 1195e9a..cb4fcd4 100644
--- a/pyspike/PieceWiseLinFunc.py
+++ b/pyspike/PieceWiseLinFunc.py
@@ -193,7 +193,7 @@ class PieceWiseLinFunc:
return integral
def avrg(self, interval=None):
- """ Computes the average of the piece-wise linear function:
+ r""" Computes the average of the piece-wise linear function:
:math:`a = 1/T \int_0^T f(x) dx` where T is the interval length.
:param interval: averaging interval given as a pair of floats, a
diff --git a/pyspike/spike_sync.py b/pyspike/spike_sync.py
index 50bb98a..dfa896a 100644
--- a/pyspike/spike_sync.py
+++ b/pyspike/spike_sync.py
@@ -165,7 +165,7 @@ def _spike_sync_values(spike_train1, spike_train2, interval, max_tau, **kwargs):
# spike_sync
############################################################
def spike_sync(*args, **kwargs):
- """ Computes the spike synchronization value of the given spike
+ r""" Computes the spike synchronization value of the given spike
trains. The spike synchronization value is the computed as the total number
of coincidences divided by the total number of spikes:
|