Skip to content
Snippets Groups Projects
Commit 64254b50 authored by Florent Jaillet's avatar Florent Jaillet
Browse files

Improve references in the documentation

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