#6607: [with patch, needs review] Quadratics in GF(2^m)
-------------------------+--------------------------------------------------
 Reporter:  wakep        |       Owner:  tbd                          
     Type:  enhancement  |      Status:  new                          
 Priority:  major        |   Milestone:                               
Component:  algebra      |    Keywords:  quadratics, characteristic 2 
 Reviewer:               |      Author:  Preston Wake, Wouter Castryck
   Merged:               |  
-------------------------+--------------------------------------------------

Comment(by mvngu):

 Please follow coding conventions, especially those documented in the
 [http://www.sagemath.org/doc/developer/conventions.html#python-coding-
 conventions Developers' Guide] and
 [http://www.python.org/dev/peps/pep-0008/ PEP-0008]. Don't be afraid to
 use white spaces in your code. The patch contains codes that are squeezed
 together; this is difficult to read. For example, this is bad:
 {{{
 def gftwosqrt(r):
     """
     Quickly finds the squareroot of an element in GF(2^m)
     """
     F=r.parent()
     c=F.cardinality()
     return r**(c/2)
 }}}
 and you should do this instead:
 {{{
 def gftwosqrt(r):
     """
     Quickly finds the squareroot of an element in GF(2^m)

     INPUT:

     <explain any input to this function>

     OUTPUT:

     <what's the expected output of this function?>

     EXAMPLES::

         <add-more-doctests-here>
     """
     F = r.parent()
     c = F.cardinality()
     return r**(c/2)
 }}}
 For more information about writing docstrings, see
 [http://www.sagemath.org/doc/developer/conventions.html#documentation-
 strings this section]. Apart from these, there are other reasons to reject
 the patch, as documented [http://www.sagemath.org/doc/developer/trac.html
 here].

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