Skip to content

Commit 0e7714a

Browse files
committed
make pyfar.FrequencyData link to pyfar doc
1 parent 205f481 commit 0e7714a

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

imkar/scattering/freefield.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,12 @@ def correlation_method(
3131
3232
Parameters
3333
----------
34-
sample_pressure : :py:class:`~pyfar.FrequencyData`, :py:class:`~pyfar.Signal`
34+
sample_pressure : pyfar.FrequencyData, pyfar.Signal
3535
Reflected sound pressure or directivity of the test sample. Its cshape
3636
must be (..., microphone_weights.size) and broadcastable to the
3737
cshape of ``reference_pressure``. The frequency vectors of both
3838
``sample_pressure`` and ``reference_pressure`` must match.
39-
reference_pressure : :py:class:`~pyfar.FrequencyData`, :py:class:`~pyfar.Signal`
39+
reference_pressure : pyfar.FrequencyData, pyfar.Signal
4040
Reflected sound pressure or directivity of the reference sample. Its
4141
cshape must be (..., microphone_weights.size) and broadcastable to the
4242
cshape of ``sample_pressure``. The frequency vectors of both
@@ -48,7 +48,7 @@ def correlation_method(
4848
4949
Returns
5050
-------
51-
scattering_coefficients : :py:class:`~pyfar.classes.audio.FrequencyData`
51+
scattering_coefficients : pyfar.FrequencyData
5252
The scattering coefficient of the broadcasted cshape of
5353
``sample_pressure`` and ``reference_pressure``, excluding the
5454
last dimension.
@@ -60,7 +60,7 @@ def correlation_method(
6060
Acoustics, vol. 60, no. 2, pp. 201-203, June 2000,
6161
doi: 10.1016/S0003-682X(99)00057-2.
6262
63-
""" # noqa: E501
63+
"""
6464
# check input types
6565
if not isinstance(sample_pressure, (pf.FrequencyData, pf.Signal)):
6666
raise TypeError(

0 commit comments

Comments
 (0)