#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: | 7ebe6616816af0eb44bfdec90ba6dc53a2080ebd
u/cheuberg/structure/element-doc | Stopgaps:
Dependencies: |
-------------------------------------+-------------------------------------
Comment (by cheuberg):
Replying to [comment:8 slelievre]:
> 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`).
done.
> Then in the paragraph about `_add_`, you could insist once again on the
presence of the def and cpdef versions.
Really? It is already in a `.. warning::` box; what else can we do?
Or are we speaking about different paragraphs?
In any case, I mention `def` and `cpdef` in the heading of the paragraph.
> Second, in the sentence ...
done.
> Last, in the sentence ...
done.
Documentation output is visible
[https://www.math.aau.at/user/cheuberg/sage/doc/6.5.beta2-6-g7ebe661/en/reference/structure/sage/structure/element.html
here].
--
Ticket URL: <http://trac.sagemath.org/ticket/17480#comment:10>
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.
