From 7d3275060c72470dc6913c0c34f211e2480fe4f4 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Marco=20Meyer-Conde=E3=80=80=E3=80=80=E3=80=80=20=20?=
 =?UTF-8?q?=E3=83=A1=E3=82=A4=E3=83=A4=E3=83=BC=E3=83=9E=E3=82=B3=E3=83=88?=
 <37673095+meiyasan@users.noreply.github.com>
Date: Thu, 5 Dec 2024 00:56:36 +0900
Subject: [PATCH] DOC: highlighted deprecations with backward compatibility
 information (#778)

---
 pywt/_extensions/_pywt.pyx | 19 +++++++++++++++----
 1 file changed, 15 insertions(+), 4 deletions(-)

diff --git a/pywt/_extensions/_pywt.pyx b/pywt/_extensions/_pywt.pyx
index fe448ca2d..3ffe41359 100644
--- a/pywt/_extensions/_pywt.pyx
+++ b/pywt/_extensions/_pywt.pyx
@@ -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: