Skip to content

Commit 9c91a19

Browse files
committed
Use short form of function/method/class links
1 parent e17a018 commit 9c91a19

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

pysoundfile.py

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,11 @@
1313
.. _CFFI: http://cffi.readthedocs.org/
1414
1515
Sound files can be read or written directly using the functions
16-
:func:`pysoundfile.read`, :func:`pysoundfile.write`, and
17-
:func:`pysoundfile.blocks`.
16+
:func:`read`, :func:`write`, and
17+
:func:`blocks`.
1818
1919
Alternatively, every sound file can be opened as a SoundFile object
20-
using the :func:`pysoundfile.SoundFile` constructor.
20+
using the :class:`SoundFile` constructor.
2121
SoundFile objects can be created
2222
for reading, writing, or both. Each SoundFile object has a samplerate,
2323
a number of channels, and a file format. These can not be changed at
@@ -416,9 +416,9 @@ def blocks(file, samplerate=None, channels=None,
416416
dtype='float64', always_2d=True, fill_value=None, out=None):
417417
"""Return a generator for block-wise processing.
418418
419-
All keyword arguments of :func:`pysoundfile.SoundFile.blocks` are
419+
All keyword arguments of :meth:`SoundFile.blocks` are
420420
allowed. All further arguments are forwarded to
421-
:class:`pysoundfile.SoundFile`.
421+
:class:`SoundFile`.
422422
423423
By default, iteration stops at the end of the file. Use ``frames``
424424
or ``stop`` to stop earlier.
@@ -590,8 +590,8 @@ def __init__(self, file, mode='r', samplerate=None, channels=None,
590590
* an *endian-ness*, which doesn't have to be specified at all in
591591
most cases.
592592
593-
The functions :func:`pysoundfile.available_formats` and
594-
:func:`pysoundfile.available_subtypes()` can be used to obtain
593+
The functions :func:`available_formats` and
594+
:func:`available_subtypes()` can be used to obtain
595595
a list of all avaliable major formats and subtypes,
596596
respectively.
597597
@@ -616,7 +616,7 @@ def __init__(self, file, mode='r', samplerate=None, channels=None,
616616
and ``'r+'`` mode. Always necessary in ``'RAW'`` format.
617617
If not given, all formats except for ``'RAW'`` will use
618618
their default subtype. See
619-
:func:`pysoundfile.available_subtypes` for all possible
619+
:func:`available_subtypes` for all possible
620620
values.
621621
endian : {'FILE', 'LITTLE', 'BIG', 'CPU'}, optional
622622
The endianness of the sound file. Not necessary in ``'r'``
@@ -628,7 +628,7 @@ def __init__(self, file, mode='r', samplerate=None, channels=None,
628628
``'r+'`` mode. Always necessary in ``'RAW'`` format or
629629
when no file extension is given. If not given, this will
630630
be determined based on the file extension. See
631-
:func:`pysoundfile.available_formats` for all possible
631+
:func:`available_formats` for all possible
632632
values.
633633
closefd : bool, optional
634634
Whether to close the file descriptor on destruction. Only

0 commit comments

Comments
 (0)