#17480: Improve documentation of element.pyx
------------------------+------------------------------------------
Reporter: cheuberg | Owner:
Type: defect | Status: new
Priority: minor | Milestone: sage-6.5
Component: coercion | Keywords: documentation, element
Merged in: | Authors:
Reviewers: | Report Upstream: N/A
Work issues: | Branch:
Commit: | Dependencies:
Stopgaps: |
------------------------+------------------------------------------
In
http://www.sagemath.org/doc/reference/structure/sage/structure/element.html
#how-to-define-a-new-element-class ,
I find the descriptions of `_add_` very confusing, because it seems to
imply that there are two versions of `_add_`, one of them as a `def` and
the other as a `cpdef`. As it stands, it reads as a circular argument.
`def RingElement._add_`: ... You should override `_add_`. .... The default
implementation of this function is to call `_add_`.
`cpdef RingElement._add_` ... which will happen if no-one has supplied
implementations of either `_add_`
I think that it does not help that Pyrex is still mentioned instead of
Cython.
Apart from that, there were several ReST formatting errors.
--
Ticket URL: <http://trac.sagemath.org/ticket/17480>
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 unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To post to this group, send email to [email protected].
Visit this group at http://groups.google.com/group/sage-trac.
For more options, visit https://groups.google.com/d/optout.
