#13969: "self" sometimes gets substituted in class docstrings
---------------------------+------------------------------------------------
Reporter: cnassau | Owner: jason
Type: defect | Status: new
Priority: major | Milestone: sage-5.7
Component: misc | Resolution:
Keywords: | Work issues:
Report Upstream: N/A | Reviewers:
Authors: | Merged in:
Dependencies: | Stopgaps:
---------------------------+------------------------------------------------
Comment (by nbruin):
Keep in mind that the substitution code is not run on the command line, so
{{{
sage: Z = random_matrix(GF(2),10,10)
sage: Z.rows?
}}}
does not produce docs with the substitution performed. That documentation
would suffer from the use of `OBJNAME` rather than `self` (since `self`
does have a meaning in that context). I think removing the automatic
substitution is a good idea (because it's so hard to decide when it is
desirable and when not), but I'm not so sure introducing a more technical
alternative is worth it. The whole idea of RST documentation is that the
text is also readable in unformatted form. This would be yet another step
away from that.
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/13969#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.
