Docstrings and Doctests for rings/quotient_ring_element.py

[cswiercz]

Current coverage in Sage 2.10.3: SCORE quotient_ring_element.py: 3% (1 of 27)

Component: doctest coverage

Issue created by migration from https://trac.sagemath.org/ticket/2507

[cswiercz]

doctests and docstrings [SCORE quotient_ring_element.py: 37% (10 of 27)]

[sagetrac-mabshoff]

comment:2

Attachment: rings.quotient_ring_element.patch.gz

Chris,

please make sure that you properly mark tickets with doctests added. Otherwise we cannot find them since attaching patches does not trigger an email to sage-trac.

Cheers,

Michael

[mwhansen]

comment:3

Attachment: 2507.patch.gz

2507.patch applies against 3.0.alpha2 and passes tests.

[sagetrac-mabshoff]

comment:4

This patch needs to be rebase. It fails to apply cleanly against my current merge tree:

sage-3.0.alpha3/devel/sage$ patch -p1 < trac_2507_rings.quotient_ring_element.patch
patching file sage/rings/quotient_ring_element.py
Hunk #1 FAILED at 66.
Hunk #2 succeeded at 147 (offset 2 lines).
Hunk #3 succeeded at 274 (offset 2 lines).

Cheers,

Michael

[malb]

comment:5

I really like that someone sat down to write doctests for quotient_ring_element.py, but I see some issues:

sage: Q = ZZ.quotient(10*ZZ)
sage: type(Q)
<class 'sage.rings.integer_mod_ring.IntegerModRing_generic'>
sage: type(Q.gen())
<type 'sage.rings.integer_mod.IntegerMod_int'>

and

sage: R.<a> = QuotientRing(QQ[x], x^2 + 1)
sage: type(R)
<class 'sage.rings.polynomial.polynomial_quotient_ring.PolynomialQuotientRing_field'>
sage: type(a)
<class 'sage.rings.polynomial.polynomial_quotient_ring_element.PolynomialQuotientRingElement'>

Thus, the documentation doesn't actually illustrate the class. AFAIK this class is mainly useful/used for multivariate polynomial rings. This theory reinforced by the lm() and monomials() methods. This class is just a mess, maybe?