#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:
-------------------------------------+-------------------------------------
Changes (by jsrn):
* commit: 9cbca19e8c5888cad642ef2c9ea8cebe642dd3ac =>
9c82dcd0c3c1938e24de9c93d3e7d3850fc7f3af
Comment:
Hi,
I've gone through the documentation and it's pretty good. I've pushed some
suggested modifications to the text, in particular mentioning a few more
keywords as well as emphasising the difference between generic codes and
families. The latter lead to a slight restructuring of your description of
`AbstractLinearCode` and `LinearCode`.
Let me know what you think, and we can co-review the ticket.
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?
Best,
Johan
----
New commits:
||[http://git.sagemath.org/sage.git/commit/?id=3b0140e6b6fae0989236dd90071c7ee3e4535bc4
3b0140e]||{{{A few more details on what a code is along with some
keywords}}}||
||[http://git.sagemath.org/sage.git/commit/?id=1efb48e91ee7cd73ed909730bc132406e3d66b95
1efb48e]||{{{More on "families" vs generic codes, and suggestions on
[Abstract]LinearCode}}}||
||[http://git.sagemath.org/sage.git/commit/?id=9c82dcd0c3c1938e24de9c93d3e7d3850fc7f3af
9c82dcd]||{{{Some polishing, and promote linear_code in documentation
index}}}||
--
Ticket URL: <http://trac.sagemath.org/ticket/20232#comment:5>
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.
