File tree Expand file tree Collapse file tree 1 file changed +15
-5
lines changed Expand file tree Collapse file tree 1 file changed +15
-5
lines changed Original file line number Diff line number Diff line change @@ -294,14 +294,24 @@ def deprecated_message(
294
294
295
295
Parameters
296
296
----------
297
- name
298
- instead
299
- since
300
- removed
301
- reference
297
+ name: str
298
+ The name of the deprecated function.
299
+ instead: Optional[:class:`str`]
300
+ A recommended alternative to the function.
301
+ since: Optional[:class:`str`]
302
+ The version in which the function was deprecated. This should be in the format ``major.minor(.patch)``, where
303
+ the patch version is optional.
304
+ removed: Optional[:class:`str`]
305
+ The version in which the function is planned to be removed. This should be in the format
306
+ ``major.minor(.patch)``, where the patch version is optional.
307
+ reference: Optional[:class:`str`]
308
+ A reference that explains the deprecation, typically a URL to a page such as a changelog entry or a GitHub
309
+ issue/PR.
302
310
303
311
Returns
304
312
-------
313
+ :class:`str`
314
+ The deprecation message.
305
315
"""
306
316
message = f"{ name } is deprecated"
307
317
if since :
You can’t perform that action at this time.
0 commit comments