Skip to content

Commit ea74b42

Browse files
committed
Explain default values of replacement/replacement_rst_doc
1 parent 8549117 commit ea74b42

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

src/sage/misc/superseded.py

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -523,10 +523,13 @@ def deprecated_function_alias(issue_number, func, *, replacement=None, replaceme
523523
- ``func`` -- the function or method to be aliased
524524
525525
- ``replacement`` -- a plain text string to be inserted
526-
into the warning message to describe the replacement
526+
into the warning message to describe the replacement.
527+
If unspecified, use the name of ``func``.
527528
528-
- ``replacement_rst_doc`` -- a restructuredText snippet to be inserted
529-
into the user documentation to describe the replacement
529+
- ``replacement_rst_doc`` -- a reStructuredText snippet to be inserted
530+
into the user documentation to describe the replacement.
531+
If unspecified, this is constructed from the name of ``func``,
532+
with either the ``:meth:`` or the ``:func:`` role, as appropriate.
530533
531534
EXAMPLES::
532535

0 commit comments

Comments
 (0)