#20705: Classes for Reed Muller Codes
-------------------------------------+-------------------------------------
       Reporter:  panda314           |        Owner:
           Type:  enhancement        |       Status:  needs_review
       Priority:  major              |    Milestone:  sage-7.3
      Component:  coding theory      |   Resolution:
       Keywords:                     |    Merged in:
        Authors:  Parthasarathi      |    Reviewers:  David Lucas
  Panda                              |  Work issues:
Report Upstream:  N/A                |       Commit:
         Branch:                     |  13cda90026b28644ed1c018d7628ea1e007cd4ef
  u/dlucas/classes_for_reed_muller_codes|     Stopgaps:
   Dependencies:                     |
-------------------------------------+-------------------------------------

Comment (by panda314):

 Replying to [comment:32 jsrn]:
 In '11.' is there any way to hyperlink the reference to ReedMullerCode in
 the reference of QAryReedMullerCode and BinaryReedMullerCode? Or shall i
 just write somehing like 'refer to documentation of' ?

 > 6. In `__eq__` you're checking equality of field cardinalities -- just
 check equality of the fields.
 > 1. In docstrings, use "Reed-Muller" consistently (and not "reed muller"
 or other things).
 > 1. In docstring warning of `ReedMullerCode`, the first sentence seems to
 be redundant (and not strictly true, since Reed-Muller codes make sense
 with order up to (d-1)*q). The same goes for the warning in
 `QaryReedMullerCode`. Also, all caps is ALWAYS ugly and impolite ;-)
 > 1. Can you please improve the documentation in `ReedMullerCode` to
 explain what a `ReedMullerCode` is? Also, the first paragraph of a
 docstring may only contain one sentence. Incidentally, in
 `ReedMullerCode`, I suggest removing the two other sentences in the first
 paragraph since that is an implementation detail and not relevant to the
 user.
 > 1. The docstring of `ReedMullerCode`, `num_of_var`: the `(i.e. m)`
 doesn't make sense to the user. Perhaps it will when you add the
 description of what a `ReedMullerCode` is.
 > 1. Perhaps add in the docstring of `QaryReedMullerCode` and
 `BinaryReedMullerCode` a reference to `ReedMullerCode` saying that this
 should usually be used, and also to see that function for description of
 the codes.
 > 1. There is some documentation missing about the order of the points
 used in  `ReedMullerCode`, `_multivariate_polynomial_interpolation`, etc.

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