#19745: Tutorial for new structures in coding theory
-------------------------------------+-------------------------------------
Reporter: dlucas | Owner:
Type: enhancement | Status: needs_review
Priority: major | Milestone: sage-7.0
Component: coding theory | Resolution:
Keywords: | Merged in:
Authors: David Lucas | Reviewers:
Report Upstream: N/A | Work issues:
Branch: | Commit:
u/dlucas/thematic_tutorial | 1795b117852cfb20eebeb637eba0d55b4bb4e995
Dependencies: | Stopgaps:
-------------------------------------+-------------------------------------
Comment (by tscrim):
Some comments:
- The second line of
{{{
....: class BinaryRepetitionCode(AbstractLinearCode):
....: _registered_encoders = {}
}}}
should be indented 4 spaces from the beginning of `class` to reflect
Python coding conventions (similar changes are needed throughout the whole
tutorial).
- I would put all of these in {{{``code_format``}}} or
{{{:meth:`reference_them`}}}:
{{{
- dimension,
- length,
- base_field and
- ambient space
}}}
- This is not formatted properly. In particular, I would make these
changes:
{{{#!diff
3. Add this line in the class' constructor::
+
- super(ClassName, self).__init__(base_field, length, "DefaultEncoder",
"DefaultDecoder")
+ super(ClassName, self).__init__(base_field, length,
"DefaultEncoder", "DefaultDecoder")
}}}
Similar changes in Section VI.
- All of those numbered points in the summary are missing periods.
- You should make this change because `\t` is a tab character:
{{{#!diff
-return "\textnormal{Binary repetition code of length } %s" %
self.length()
+return "\\textnormal{Binary repetition code of length } %s" %
self.length()
}}}
- It is considered better to have multiline statements wrapped in
parentheses rather than use the line break `\`. The parentheses have the
effect that it groups things together in logical units and the line break
is not needed.
- Errors should be phrases, and as such, should not start with a capital
letter: `DecodingFailure("impossible to find a majority")`
Otherwise it looks good to me. (Although I'm somewhat torn about using
contractions in tutorials/documentation. I leave that decision up to you.)
--
Ticket URL: <http://trac.sagemath.org/ticket/19745#comment:10>
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.
