Skip to content

Commit 7d32750

Browse files
authored
DOC: highlighted deprecations with backward compatibility information (#778)
1 parent 5f3e52b commit 7d32750

File tree

1 file changed

+15
-4
lines changed

1 file changed

+15
-4
lines changed

pywt/_extensions/_pywt.pyx

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -705,17 +705,28 @@ cdef public class ContinuousWavelet [type ContinuousWaveletType, object Continuo
705705
msg = (
706706
"Wavelets of family {0}, without parameters "
707707
"specified in the name are deprecated. The name "
708-
"should take the form {0}M-B-C where M is the spline "
708+
"should follow the format {0}M-B-C where M is the spline "
709709
"order and B, C are floats representing the bandwidth "
710710
"frequency and center frequency, respectively "
711-
"(example: {0}1-1.5-1.0).").format(base_name)
711+
"(example, for backward compatibility: "
712+
"{0} = {0}2-1.0-0.5).").format(base_name)
713+
elif base_name == 'shan':
714+
msg = (
715+
"Wavelets from the family {0}, without parameters "
716+
"specified in the name are deprecated. The name "
717+
"should follow the format {0}B-C, where B and C are floats "
718+
"representing the bandwidth frequency and center "
719+
"frequency, respectively (example, for backward "
720+
"compatibility: {0} = {0}0.5-1.0)."
721+
).format(base_name)
712722
else:
713723
msg = (
714724
"Wavelets from the family {0}, without parameters "
715725
"specified in the name are deprecated. The name "
716-
"should takethe form {0}B-C where B and C are floats "
726+
"should follow the format {0}B-C, where B and C are floats "
717727
"representing the bandwidth frequency and center "
718-
"frequency, respectively (example: {0}1.5-1.0)."
728+
"frequency, respectively (example, for backward "
729+
"compatibility: {0} = {0}1.0-0.5)."
719730
).format(base_name)
720731
warnings.warn(msg, FutureWarning)
721732
else:

0 commit comments

Comments
 (0)