#2507: [with patch; needs work] Docstrings and Doctests for
rings/quotient_ring_element.py
----------------------+-----------------------------------------------------
Reporter: cswiercz | Owner: cswiercz
Type: defect | Status: assigned
Priority: minor | Milestone: sage-4.0
Component: doctest | Keywords: docstring, doctest
----------------------+-----------------------------------------------------
Comment(by mvngu):
First, two trivial issues with the patch {{{trac_2507.patch}}}. The double
colon on line 48 is not indented properly. It should be aligned with the
double colon on line 53. Also, the docstring for {{{_div_}}} is a bit
confusing due to excessive use of the word "quotient". The word "quotient"
as used in
{{{
263 Quotient of quotient ring element ``self`` by another
quotient ring
264 element, ``right``. If the quotient is `R/I`, the division
is
265 carried out in `R` and then reduced to `R/I`.
}}}
has two meanings: to denote division of one element by another; and to
mean a quotient ring. When division is intended, I think "division" should
be used instead of quotient. So line 263 of the docstring can be changed
as follows to avoid confusion/ambiguity:
{{{
263 Division of quotient ring element ``self`` by another
quotient ring
264 element, ``right``. If the quotient is `R/I`, the division
is
265 carried out in `R` and then reduced to `R/I`.
}}}
The other issue is that in the constructor signature
{{{
77 def __init__(self, parent, rep, reduce=True):
}}}
the input are not documented. My knowledge of quotient rings is pretty
limited, and it can be difficult to work out what each of the arguments
{{{parent}}}, {{{rep}}} and {{{reduce=True}}} means, and how to use them
properly.
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/2507#comment:13>
Sage <http://sagemath.org/>
Sage - Open Source Mathematical Software: Building the Car Instead of
Reinventing the Wheel
--~--~---------~--~----~------------~-------~--~----~
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
-~----------~----~----~----~------~----~------~--~---
