#17480: Improve documentation of element.pyx
-------------------------------------+-------------------------------------
Reporter: cheuberg | Owner:
Type: defect | Status: needs_review
Priority: minor | Milestone: sage-6.5
Component: coercion | Resolution:
Keywords: documentation, | Merged in:
element | Reviewers:
Authors: | Work issues:
Report Upstream: N/A | Commit:
Branch: | 2e57cf9b90adb965cf3bd13725fac79eb7cec2ca
u/cheuberg/structure/element-doc | Stopgaps:
Dependencies: |
-------------------------------------+-------------------------------------
Comment (by slelievre):
It's good that you are refreshing this part of the documentation, if only
to update references to Pyrex, and instead refer to Cython! Here are three
more thoughts.
First, maybe it would be worth pointing to the subtle ways in which these
functions differ in names and in nature, by saying for instance:
There are three relevant functions, with subtly differing names (add vs
iadd, single vs double underscores), one of which has both a Python and a
Cython version (note the `def` vs `cpdef`).
Then in the paragraph about `_add_`, you could insist once again on the
presence of the def and cpdef versions.
Second, in the sentence
For speed, there are also inplace version of the arithmetic commands.
we want "inplace versions" (plural).
Last, in the sentence
This is the function you should override to inplace implement addition
in a Python subclass of `RingElement`.
I would change "to inplace implement addition" to "to implement inplace
addition".
--
Ticket URL: <http://trac.sagemath.org/ticket/17480#comment:8>
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.
