Skip to content

Commit

Permalink
Fixed sphinx link :object: to :obj:
Browse files Browse the repository at this point in the history
  • Loading branch information
hokiedsp committed Feb 28, 2021
1 parent fb2e1ed commit e4d4510
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 19 deletions.
18 changes: 9 additions & 9 deletions src/parselmouth/LPC_docstrings.h
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,13 @@ a frame of acoustic data samples.
Note that the $a_0=1$ coefficient is omitted in a.
This class is instantiated in :object:`~parselmouth.LPC` object and not
This class is instantiated in :obj:`~parselmouth.LPC` object and not
intended to be instantiated by user.
See also
--------
:praat:`Sound: LPC analysis`
:object:`~parselmouth.LPC`
:obj:`~parselmouth.LPC`
)";

constexpr auto FRAME_N_COEFFICIENTS = R"(int : Number of AR coefficients a used to model the frame)";
Expand All @@ -40,13 +40,13 @@ samples, x′n = ∑ ak xn-k then {a1, a2, ..., ap} can be chosen to minimize
the prediction power Qp where Qp = E[ |xn - x′n|2 ].
This class is not intended to be instantiated by user, instead from a
:object:`~parselmouth.Sound` object using one of its to_lpc_xxx()
:obj:`~parselmouth.Sound` object using one of its to_lpc_xxx()
methods.
See Also
--------
:praat:`Sound: LPC analysis`
:object:`parselmouth.LPC.Frame`
:obj:`parselmouth.LPC.Frame`
:func:`parselmouth.Sound.to_lpc_autocorrelation`
:func:`parselmouth.Sound.to_lpc_covariance`
:func:`parselmouth.Sound.to_lpc_burg`
Expand All @@ -58,7 +58,7 @@ constexpr auto MAX_N_COEFFICIENTS_DOCSTRING = R"(Largest number of coefficients

constexpr auto TO_LINE_SPECTRAL_FREQUENCIES=R"(Convert to line spectra.
Returns :object:`parselmouth.LineSpectralFrequencies` object with the
Returns :obj:`parselmouth.LineSpectralFrequencies` object with the
line frequencies found in the LPC models.
Parameter
Expand All @@ -68,17 +68,17 @@ grid_size : float, default=0.0
See also
--------
:object:`parselmouth.LineSpectralFrequencies`
:obj:`parselmouth.LineSpectralFrequencies`
)";


constexpr auto TO_SPECTRUM_SLICE_DOCSTRING=R"(Convert to spectrogram.
Returns :object:`parselmouth.Spectrum` object with the spectral
Returns :obj:`parselmouth.Spectrum` object with the spectral
representation of the LPC model found at specified time t.
The Spectrum at t will be calculated from the nearest
:object:`~parselmouth.LPC.Frame`. See :praat:`LPC: To Spectrum (slice)...`
:obj:`~parselmouth.LPC.Frame`. See :praat:`LPC: To Spectrum (slice)...`
for dedailed algorithm description.
Parameters
Expand Down Expand Up @@ -111,7 +111,7 @@ See also

constexpr auto TO_SPECTROGRAM_DOCSTRING=R"(Convert to spectrogram.
Returns :object:`parselmouth.Spectrogram` object with the spectral
Returns :obj:`parselmouth.Spectrogram` object with the spectral
representation of the LPC models.
For each LPC_Frame the corresponding Spectrum will be calculated according
Expand Down
4 changes: 2 additions & 2 deletions src/parselmouth/LineSpectralFrequencies_docstrings.h
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,11 @@ constexpr auto MAXIMUM_NUMBER_OF_FREQUENCIES_DOCSTRING = R"(int, readonly : Larg

constexpr auto TO_LPC_DOCSTRING=R"(Convert to LPC object.
Returns :object:`parselmouth.LPC` object with equivalent AR models.
Returns :obj:`parselmouth.LPC` object with equivalent AR models.
See also
--------
:object:`parselmouth.LPC`
:obj:`parselmouth.LPC`
:func:`parselmouth.LPC.to_line_spectral_frequencies`
)";

Expand Down
16 changes: 8 additions & 8 deletions src/parselmouth/Sound_docstrings.h
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ namespace parselmouth {
constexpr auto TO_LPC_AUTOCORRELATION_DOCSTRING = R"(Create LPC using autocorrelation method.
Run linear predictive coding (LPC) analysis with the autocorrelation
method and returns a new :object:`~parselmouth.LPC` object containing the
method and returns a new :obj:`~parselmouth.LPC` object containing the
analysis outcomes.
The autocorrelation algorithm is decribed in Markel & Gray (1976).
Expand Down Expand Up @@ -37,7 +37,7 @@ preemphasis_frequency : float, default=50.0
See Also
--------
:praat:`Sound: To LPC (autocorrelation)...`
:object:`~parselmouth.LPC`
:obj:`~parselmouth.LPC`
:func:`~parselmouth.Sound.to_lpc_covariance`
:func:`~parselmouth.Sound.to_lpc_burg`
:func:`~parselmouth.Sound.to_lpc_marple`
Expand All @@ -46,7 +46,7 @@ See Also
constexpr auto TO_LPC_COVARIANCE_DOCSTRING = R"(Create LPC using covariance method.
Run linear predictive coding (LPC) analysis with the covariance method and
returns a new :object:`~parselmouth.LPC` object containing the analysis
returns a new :obj:`~parselmouth.LPC` object containing the analysis
outcomes.
The covariance algorithm is decribed in Markel & Gray (1976).
Expand Down Expand Up @@ -78,7 +78,7 @@ preemphasis_frequency : float, default=50.0
See Also
--------
:praat:`Sound: To LPC (covariance)...`
:object:`~parselmouth.LPC`
:obj:`~parselmouth.LPC`
:func:`~parselmouth.Sound.to_lpc_autocorrelation`
:func:`~parselmouth.Sound.to_lpc_burg`
:func:`~parselmouth.Sound.to_lpc_marple`
Expand All @@ -87,7 +87,7 @@ See Also
constexpr auto TO_LPC_BURG_DOCSTRING = R"(Create LPC using Burg's method.
Run linear predictive coding (LPC) analysis with the Burg's method and
returns a new :object:`~parselmouth.LPC` object containing the analysis
returns a new :obj:`~parselmouth.LPC` object containing the analysis
outcomes.
Burg's algorithm is described in Anderson (1978)
Expand Down Expand Up @@ -119,7 +119,7 @@ preemphasis_frequency : float, default=50.0
See Also
--------
:praat:`Sound: To LPC (burg)...`
:object:`~parselmouth.LPC`
:obj:`~parselmouth.LPC`
:func:`~parselmouth.Sound.to_lpc_autocorrelation`
:func:`~parselmouth.Sound.to_lpc_covariance`
:func:`~parselmouth.Sound.to_lpc_marple`
Expand All @@ -128,7 +128,7 @@ See Also
constexpr auto TO_LPC_MARPLE_DOCSTRING = R"(Create LPC using Marple's method.
Run linear predictive coding (LPC) analysis with the Marple's method and
returns a new :object:`~parselmouth.LPC` object containing the analysis
returns a new :obj:`~parselmouth.LPC` object containing the analysis
outcomes.
The algorithm is described in Marple (1980).
Expand Down Expand Up @@ -167,7 +167,7 @@ tolerance 2 : float, default=1e-6
See Also
--------
:praat:`Sound: To LPC (marple)...`
:object:`~parselmouth.LPC`
:obj:`~parselmouth.LPC`
:func:`~parselmouth.Sound.to_lpc_autocorrelation`
:func:`~parselmouth.Sound.to_lpc_covariance`
:func:`~parselmouth.Sound.to_lpc_burg`
Expand Down

0 comments on commit e4d4510

Please sign in to comment.