We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
There was an error while loading. Please reload this page.
1 parent 97d6bbb commit 5157766Copy full SHA for 5157766
doc/source/how-to/deprecating.rst
@@ -72,6 +72,10 @@ is used in this guide.
72
73
5. **(Optional) Add a warning in the code**: If applicable, add a warning in the code itself to inform users
74
that the library is deprecated. This can be done using Python's `warnings` module. For example:
75
+
76
+ .. note::
77
78
+ Make sure to adapt the URL in the warning message.
79
80
.. code:: python
81
@@ -81,7 +85,8 @@ is used in this guide.
85
82
86
warnings.warn(
83
87
"This library is deprecated and will no longer be maintained. "
84
- "Please consider using alternatives.",
88
+ "Please consider using alternatives. "
89
+ "For more information check https://github.com/ansys/<repository>/issues",
90
DeprecationWarning,
91
)
92
0 commit comments