#11784: Add more sanity checks to Galois Field constructor
--------------------------------+-------------------------------------------
   Reporter:  lftabera          |          Owner:  lftabera                 
       Type:  defect            |         Status:  needs_work               
   Priority:  major             |      Milestone:  sage-4.8                 
  Component:  basic arithmetic  |       Keywords:  beginner                 
Work_issues:                    |       Upstream:  N/A                      
   Reviewer:                    |         Author:  Luis Felipe Tabera Alonso
     Merged:                    |   Dependencies:                           
--------------------------------+-------------------------------------------
Changes (by johanbosman):

  * keywords:  begginer => beginner
  * status:  needs_review => needs_work


Comment:

 It surprises me that Sage didn't check this, wow.

 At a few points, your spacing in the docstring is not in compliance with
 the Python guideline (see http://www.python.org/dev/peps/pep-0008/).  In
 order to avoid messiness or sloppiness in the documentation, it would be
 good to correct this.

 For instance:
 {{{
 irreducibility modulo p. Also, the modulus has to be of the right degree.
 }}}
 The period should be followed by two spaces.
 {{{
 sage: L=GF(3**2,name='a', modulus=QQ[x](x-1), check_irreducible=False)
 sage: L.list() #random
 }}}
 In the first line, there should be spaces between the = operator and a
 space after the first comma.  In the second line, put 2 spaces before #
 and 1 after #.

 It would also be good to put spaces around a few more mathematical
 operators.  Though I don't think we should be as strict as in the Python
 guideline here; just do it in cases where it will increase readability
 (don't do it for ** for instance).

-- 
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/11784#comment:4>
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 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.

Reply via email to