Skip to content

Commit

Permalink
Update docs for phonspec specstyle arg
Browse files Browse the repository at this point in the history
  • Loading branch information
maetshju committed Dec 29, 2023
1 parent 751eb85 commit 8533b42
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions src/phon_spectrogram.jl
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ using DSP
using RecipesBase

"""
phonspec(s, fs; pre_emph=0.97, style=:broadband, dbr=55, kw...)
phonspec(s, fs; pre_emph=0.97, specstyle=:broadband, dbr=55, kw...)
Rudimentary functionality to plot a spectrogram, with parameters familiar to phoneticians.
Includes a pre-emphasis routine which helps increase the intensity of the
Expand All @@ -19,7 +19,7 @@ Args
* `s` A vector containing the samples of a sound
* `fs` Sampling frequency of `s` in Hz
* `pre_emph` The α coefficient for pre-emmphasis; default value of 0.97 corresponds to a cutoff frequency of approximately 213 Hz before the 6 dB / octave increase begins
* `style` Either `:broadband` or `:narrowband`; will affect the window length and window stride
* `specstyle` Either `:broadband` or `:narrowband`; will affect the window length and window stride
* `dbr` The dynamic range; all frequencies that are `dbr` decibels quieter than the loudest frequency will not be displayed; will specify the `clim` argument
* `kw...` extra named parameters to pass to `heatmap`
"""
Expand Down

2 comments on commit 8533b42

@maetshju
Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator register

Release notes:

Breaking changes

In the interface for phonspec, the style argument to specstyle to prevent a collision with the style argument in functions from Plots.jl.

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/97918

Tagging

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.4.0 -m "<description of version>" 8533b42a57bc5a12f485aadaf0b5dd874583aa79
git push origin v0.4.0

Please sign in to comment.