#20232: Rewrite module doc of `LinearCode`
-------------------------------------+-------------------------------------
       Reporter:  jsrn               |        Owner:
           Type:  enhancement        |       Status:  needs_review
       Priority:  major              |    Milestone:  sage-7.3
      Component:  coding theory      |   Resolution:
       Keywords:                     |    Merged in:
        Authors:                     |    Reviewers:
Report Upstream:  N/A                |  Work issues:
         Branch:                     |       Commit:
  u/dlucas/rewrite_doc_for_linear_code|  
9cbca19e8c5888cad642ef2c9ea8cebe642dd3ac
   Dependencies:                     |     Stopgaps:
-------------------------------------+-------------------------------------
Changes (by dlucas):

 * status:  new => needs_review
 * commit:   => 9cbca19e8c5888cad642ef2c9ea8cebe642dd3ac
 * milestone:  sage-7.1 => sage-7.3


Comment:

 Hello,

 I rewrote the module docstring of `linear_code.py`. To be more specific,
 I:

 - completely removed the old docstring, which was, imho, focused on
 mathematical details and advanced specificities,
 - wrote a very small definition of a linear code,
 - explained the difference between `AbstractLinearCode` and `LinearCode`,
 and
 - gave pointers to more detailed content (thematic tutorials).

 I'm setting this to `needs_review`.

 David
 ----
 New commits:
 
||[http://git.sagemath.org/sage.git/commit/?id=9cbca19e8c5888cad642ef2c9ea8cebe642dd3ac
 9cbca19]||{{{Rewrote module documentation for linear_code.py}}}||

--
Ticket URL: <http://trac.sagemath.org/ticket/20232#comment:2>
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 https://groups.google.com/group/sage-trac.
For more options, visit https://groups.google.com/d/optout.

Reply via email to