#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/jsrn/rewrite_doc_for_linear_code | 9c82dcd0c3c1938e24de9c93d3e7d3850fc7f3af
Dependencies: | Stopgaps:
-------------------------------------+-------------------------------------
Comment (by dlucas):
Hello,
> Let me know what you think, and we can co-review the ticket.
I'm fine with your changes. It's indeed better to emphasise the difference
between generic codes and families, as I'm not it's standard terminology
so the more specific, the better.
I also agree with the definition of encoding, dual codes, etc: these are
very useful concepts which deserve to be defined here.
> I also promoted linear_code in the reference manual module index, so
that it figures first in its respective category. However, that lead me to
thinking that perhaps some of this text should go there (not necessarily
in this ticket)? What do you think -- where do people look?
I think we should left it as is: this file is supposed to be an index, as
in any book, and when you're browsing an index, you usually expect quick
access to the entry you're looking for - not some definitions. That's why
I changed the name of the entry, from `Linear codes` to `Generic
structures for linear codes`: with this new name, one knows exactly what
to expect when one clicks on this entry.
Best,
David
--
Ticket URL: <http://trac.sagemath.org/ticket/20232#comment:6>
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.
