Skip to content

DOC: highlighted deprecations with backward compatibility information #778

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rgommers merged 2 commits into from
Dec 4, 2024
Merged

DOC: highlighted deprecations with backward compatibility information #778

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fa4f615
update deprecation message with backward compatibility information
meiyasan Nov 22, 2024
2722720
Fix a few missing spaces
rgommers Nov 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 15 additions & 4 deletions pywt/_extensions/_pywt.pyx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -705,17 +705,28 @@ cdef public class ContinuousWavelet [type ContinuousWaveletType, object Continuo
msg = (
"Wavelets of family {0}, without parameters "
"specified in the name are deprecated. The name "
"should take the form {0}M-B-C where M is the spline "
"should follow the format {0}M-B-C where M is the spline "
"order and B, C are floats representing the bandwidth "
"frequency and center frequency, respectively "
"(example: {0}1-1.5-1.0).").format(base_name)
"(example, for backward compatibility: "
"{0} = {0}2-1.0-0.5).").format(base_name)
elif base_name == 'shan':
msg = (
"Wavelets from the family {0}, without parameters "
"specified in the name are deprecated. The name "
"should follow the format {0}B-C, where B and C are floats "
"representing the bandwidth frequency and center "
"frequency, respectively (example, for backward "
"compatibility: {0} = {0}0.5-1.0)."
).format(base_name)
else:
msg = (
"Wavelets from the family {0}, without parameters "
"specified in the name are deprecated. The name "
"should takethe form {0}B-C where B and C are floats "
"should follow the format {0}B-C, where B and C are floats "
"representing the bandwidth frequency and center "
"frequency, respectively (example: {0}1.5-1.0)."
"frequency, respectively (example, for backward "
"compatibility: {0} = {0}1.0-0.5)."
).format(base_name)
warnings.warn(msg, FutureWarning)
else:
Expand Down