Commit 64254b50 authored by Florent Jaillet's avatar Florent Jaillet

Improve references in the documentation

parent 6694be52
Pipeline #614 passed with stage
in 18 seconds
......@@ -73,9 +73,9 @@ def _check_compatibility_fs(w1, w2):
class Waveform(MadArray):
"""Subclass of MadArray to handle mono and stereo audio signals.
:class:`Waveform` inherits from :class:`MadArray` and adds an attribute
`fs` to store the sampling frequency, as well as methods to facilitate the
manipulation of audio files.
:class:`Waveform` inherits from :class:`~madarrays.mad_array.MadArray` and
adds an attribute :attr:`fs` to store the sampling frequency, as well as
methods to facilitate the manipulation of audio files.
.. _type_entry_waveform:
......@@ -126,8 +126,8 @@ class Waveform(MadArray):
**Masking**: Waveform allows for complex entries, but only real-like
masking is permitted, i.e. it is not possible to mask only the phase or the
amplitude. In particular, this implies that the attribute
:attr:`_is_complex` inherited from :class:`MadArray` is always equal to
False.
:attr:`_is_complex` inherited from :class:`~madarrays.mad_array.MadArray`
is always equal to False.
Parameters
----------
......@@ -142,7 +142,7 @@ class Waveform(MadArray):
Boolean mask with True values for missing samples. Its shape must be
the same as ``data``.
indexing :
See :class:`MadArray`.
See :class:`~madarrays.mad_array.MadArray`.
"""
def __new__(cls, data, fs=None, mask=None, masked_indexing=None):
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment