#8885: Add deprecation message to deprecated_functions_alias docstrings
-----------------------------+----------------------------------------------
Reporter: hivert | Owner: hivert
Type: defect | Status: needs_info
Priority: major | Milestone: sage-4.7.1
Component: documentation | Keywords: Depreacation alias documentation
Work_issues: | Upstream: N/A
Reviewer: | Author: Florent Hivert
Merged: | Dependencies:
-----------------------------+----------------------------------------------
Comment(by hivert):
Hi Mariah,
Replying to [comment:3 mariah]:
> I applied the patch to sage-4.7.1.alpha1, did 'sage -b', and rebuilt the
> documentation. Yet when I look at the doc of
{{{sage.combinat.partition.associated}}},
> I do not see anything saying that the function is deprecated. Am I
missing something?
This is what I got under the command line
{{{
sage: P.associated?
Type: DeprecatedFunctionAlias
Base Class: <class 'sage.misc.misc.DeprecatedFunctionAlias'>
String Form: <sage.misc.misc.DeprecatedFunctionAlias object at
0x30c6210>
Namespace: Interactive
File: /home/florent/src/Sage/sage/local/lib/python2.6/site-
packages/sage/misc/misc.py
Definition: P.associated(self, *args, **kwds)
Docstring:
Deprecated since version Sage: Version 4.4. Use ``conjugate()``
instead.
[...]
}}}
It also work under the notebook and the html built doc.
How did you rebuild the documentation ? If you just did {{{sage -docbuild
reference html}}} then without touching {{{partitions.py}}} Sphinx
consider it
upto date and doesn't rebuild the documentation. Is that what you did ?
Florent
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/8885#comment:4>
Sage <http://www.sagemath.org>
Sage: Creating a Viable Open Source Alternative to Magma, Maple, Mathematica,
and MATLAB
--
You received this message because you are subscribed to the Google Groups
"sage-trac" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/sage-trac?hl=en.
