Opened 11 years ago
Last modified 11 years ago
#11585 closed enhancement
Make deprecated_function_alias print the whole module path when it differs from the original — at Version 3
Reported by: | Luca De Feo | Owned by: | Jason Grout |
---|---|---|---|
Priority: | minor | Milestone: | sage-5.0 |
Component: | misc | Keywords: | deprecation |
Cc: | Florent Hivert | Merged in: | |
Authors: | Luca De Feo | Reviewers: | Rob Beezer |
Report Upstream: | N/A | Work issues: | |
Branch: | Commit: | ||
Dependencies: | Stopgaps: |
Description (last modified by )
Currently
sage: from sage.misc.misc import deprecated_function_alias sage: a = deprecated_function_alias(sqrt, "Version ?") sage: a(5) ... DeprecationWarning: (Since Version ?) a is deprecated. Please use sqrt instead. sqrt(5)
Apply:
which is misleading because the user would expect to find sqrt
in the same module as a
.
With this patch
sage: from sage.misc.misc import deprecated_function_alias sage: a = deprecated_function_alias(sqrt, "Version ?") sage: a(5) ... DeprecationWarning: (Since Version ?) a is deprecated. Please use sage.functions.other.sqrt instead. sqrt(5)
There's no change in deprecating methods.
Change History (5)
Changed 11 years ago by
Attachment: | trac_11585_depracted_function_alias.patch added |
---|
comment:1 Changed 11 years ago by
Status: | new → needs_review |
---|
comment:2 Changed 11 years ago by
Cc: | Florent Hivert added |
---|---|
Description: | modified (diff) |
Reviewers: | → Rob Beezer |
Status: | needs_review → needs_work |
Changed 11 years ago by
Attachment: | trac_11585_deprecated_function_alias.patch added |
---|
comment:3 Changed 11 years ago by
Description: | modified (diff) |
---|---|
Status: | needs_work → needs_review |
Modified as requested by rbeezer. Apply second patch only (sorry for the mispelling in the first patch).
Note: See
TracTickets for help on using
tickets.
Looks good. Passes long tests on 4.7.1.alpha3. I've cc'ed Florent Hivert in case he wants to add anything. I've also added an "Apply" section to the description for the release manager.
Two minor formatting items need attention.
Line 2287:
Trac #11585::
You need a blank line after the double-colon to make the verbatim text format properly.
You can test documentation via
sage -docbuild reference html
after a fresh build (sage -b
) and then viewing the resulting HTML file.Line 2299:
should be formatted as
See http://www.sagemath.org/doc/developer/conventions.html
which references: http://www.python.org/dev/peps/pep-0008/
(look shortly after "Compound statements")