Skip to content

Commit 5157766

Browse files
authored
Apply suggestions from code review
1 parent 97d6bbb commit 5157766

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

doc/source/how-to/deprecating.rst

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,10 @@ is used in this guide.
7272

7373
5. **(Optional) Add a warning in the code**: If applicable, add a warning in the code itself to inform users
7474
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.
7579

7680
.. code:: python
7781
@@ -81,7 +85,8 @@ is used in this guide.
8185
8286
warnings.warn(
8387
"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",
8590
DeprecationWarning,
8691
)
8792

0 commit comments

Comments
 (0)