sage.coding: Modularization fixes, doctest cosmetics, add # optional

src/sage/coding/abstract_code.py

@@ -1,3 +1,4 @@
+# sage.doctest: optional - sage.modules sage.rings.finite_rings
 r"""
 Codes
 
@@ -151,9 +152,9 @@ class AbstractCode(Parent):
 
     To implement a code, you need to:
 
-    - inherit from AbstractCode
+    - inherit from :class:`AbstractCode`
 
-    - call AbstractCode ``__init__`` method in the subclass constructor.
+    - call :class:`AbstractCode` ``__init__`` method in the subclass constructor.
       Example: ``super().__init__(length, "EncoderName",
       "DecoderName", "metric")``. "EncoderName" and "DecoderName" are set to
       ``None`` by default, a generic code class such as AbstractCode does
@@ -196,9 +197,9 @@ class AbstractCode(Parent):
       ``MyDecoderClass``.
 
 
-    As AbstractCode is not designed to be implemented, it does not have any
-    representation methods. You should implement ``_repr_`` and ``_latex_``
-    methods in the subclass.
+    As the class :class:`AbstractCode` is not designed to be instantiated, it
+    does not have any representation methods. You should implement ``_repr_``
+    and ``_latex_`` methods in the subclass.
     """
 
     def __init__(self, length, default_encoder_name=None,
@@ -226,7 +227,7 @@ def __init__(self, length, default_encoder_name=None,
 
         EXAMPLES:
 
-        The following example demonstrates how to use subclass `AbstractCode`
+        The following example demonstrates how to use a subclass of ``AbstractCode``
         for representing a new family of codes::
 
             sage: from sage.coding.abstract_code import AbstractCode
@@ -665,7 +666,7 @@ def add_encoder(self, name, encoder):
 
     def decode_to_code(self, word, decoder_name=None, *args, **kwargs):
         r"""
-        Corrects the errors in ``word`` and returns a codeword.
+        Correct the errors in ``word`` and returns a codeword.
 
         INPUT:
 
@@ -683,7 +684,8 @@ def decode_to_code(self, word, decoder_name=None, *args, **kwargs):
 
         EXAMPLES::
 
-            sage: G = Matrix(GF(2), [[1,1,1,0,0,0,0],[1,0,0,1,1,0,0],[0,1,0,1,0,1,0],[1,1,0,1,0,0,1]])
+            sage: G = Matrix(GF(2), [[1,1,1,0,0,0,0], [1,0,0,1,1,0,0],
+            ....:                    [0,1,0,1,0,1,0], [1,1,0,1,0,0,1]])
             sage: C = LinearCode(G)
             sage: word = vector(GF(2), (1, 1, 0, 0, 1, 1, 0))
             sage: w_err = word + vector(GF(2), (1, 0, 0, 0, 0, 0, 0))
@@ -720,7 +722,8 @@ def decode_to_message(self, word, decoder_name=None, *args, **kwargs):
 
         EXAMPLES::
 
-            sage: G = Matrix(GF(2), [[1,1,1,0,0,0,0],[1,0,0,1,1,0,0],[0,1,0,1,0,1,0],[1,1,0,1,0,0,1]])
+            sage: G = Matrix(GF(2), [[1,1,1,0,0,0,0], [1,0,0,1,1,0,0],
+            ....:                    [0,1,0,1,0,1,0], [1,1,0,1,0,0,1]])
             sage: C = LinearCode(G)
             sage: word = vector(GF(2), (1, 1, 0, 0, 1, 1, 0))
             sage: C.decode_to_message(word)
@@ -759,7 +762,8 @@ def decoder(self, decoder_name=None, *args, **kwargs):
 
         EXAMPLES::
 
-            sage: G = Matrix(GF(2), [[1,1,1,0,0,0,0],[1,0,0,1,1,0,0],[0,1,0,1,0,1,0],[1,1,0,1,0,0,1]])
+            sage: G = Matrix(GF(2), [[1,1,1,0,0,0,0], [1,0,0,1,1,0,0],
+            ....:                    [0,1,0,1,0,1,0], [1,1,0,1,0,0,1]])
             sage: C = LinearCode(G)
             sage: C.decoder()
             Syndrome decoder for [7, 4] linear code over GF(2) handling errors of weight up to 1
@@ -790,19 +794,22 @@ def decoder(self, decoder_name=None, *args, **kwargs):
             sage: C.decoder('Try')
             Traceback (most recent call last):
             ...
-            ValueError: There is no Decoder named 'Try'. The known Decoders are: ['InformationSet', 'NearestNeighbor', 'Syndrome']
+            ValueError: There is no Decoder named 'Try'.
+            The known Decoders are: ['InformationSet', 'NearestNeighbor', 'Syndrome']
 
         Some decoders take extra arguments. If the user forgets to supply these,
         the error message attempts to be helpful::
 
             sage: C.decoder('InformationSet')
             Traceback (most recent call last):
             ...
-            ValueError: Constructing the InformationSet decoder failed, possibly due to missing or incorrect parameters.
+            ValueError: Constructing the InformationSet decoder failed,
+            possibly due to missing or incorrect parameters.
             The constructor requires the arguments ['number_errors'].
             It takes the optional arguments ['algorithm'].
-            It accepts unspecified arguments as well.
-            See the documentation of sage.coding.information_set_decoder.LinearCodeInformationSetDecoder for more details.
+            It accepts unspecified arguments as well. See the documentation of
+            sage.coding.information_set_decoder.LinearCodeInformationSetDecoder
+            for more details.
 
         """
         if not self._default_decoder_name:
@@ -830,14 +837,15 @@ def decoders_available(self, classes=False):
         INPUT:
 
         - ``classes`` -- (default: ``False``) if ``classes`` is set to ``True``,
-          return instead a ``dict`` mapping available decoder name to the
+          return instead a :class:`dict` mapping available decoder name to the
           associated decoder class.
 
-        OUTPUT: a list of strings, or a `dict` mapping strings to classes.
+        OUTPUT: a list of strings, or a :class:`dict` mapping strings to classes.
 
         EXAMPLES::
 
-            sage: G = Matrix(GF(2), [[1,1,1,0,0,0,0],[1,0,0,1,1,0,0],[0,1,0,1,0,1,0],[1,1,0,1,0,0,1]])
+            sage: G = Matrix(GF(2), [[1,1,1,0,0,0,0], [1,0,0,1,1,0,0],
+            ....:                    [0,1,0,1,0,1,0], [1,1,0,1,0,0,1]])
             sage: C = LinearCode(G)
             sage: C.decoders_available()
             ['InformationSet', 'NearestNeighbor', 'Syndrome']
@@ -878,7 +886,8 @@ def encode(self, word, encoder_name=None, *args, **kwargs):
 
         EXAMPLES::
 
-            sage: G = Matrix(GF(2), [[1,1,1,0,0,0,0],[1,0,0,1,1,0,0],[0,1,0,1,0,1,0],[1,1,0,1,0,0,1]])
+            sage: G = Matrix(GF(2), [[1,1,1,0,0,0,0], [1,0,0,1,1,0,0],
+            ....:                    [0,1,0,1,0,1,0], [1,1,0,1,0,0,1]])
             sage: C = LinearCode(G)
             sage: word = vector((0, 1, 1, 0))
             sage: C.encode(word)
@@ -928,7 +937,8 @@ def encoder(self, encoder_name=None, *args, **kwargs):
 
         EXAMPLES::
 
-            sage: G = Matrix(GF(2), [[1,1,1,0,0,0,0],[1,0,0,1,1,0,0],[0,1,0,1,0,1,0],[1,1,0,1,0,0,1]])
+            sage: G = Matrix(GF(2), [[1,1,1,0,0,0,0], [1,0,0,1,1,0,0],
+            ....:                    [0,1,0,1,0,1,0], [1,1,0,1,0,0,1]])
             sage: C = LinearCode(G)
             sage: C.encoder()
             Generator matrix-based encoder for [7, 4] linear code over GF(2)
@@ -944,7 +954,8 @@ def encoder(self, encoder_name=None, *args, **kwargs):
             ....:   def field(self):
             ....:       return self._field
             ....:   def _repr_(self):
-            ....:       return "%d dummy code over GF(%s)" % (self.length(), self.field().cardinality())
+            ....:       return "%d dummy code over GF(%s)" % (self.length(),
+            ....:                                             self.field().cardinality())
             sage: D = MyCodeFamily(5, GF(2))
             sage: D.encoder()
             Traceback (most recent call last):
@@ -964,18 +975,21 @@ def encoder(self, encoder_name=None, *args, **kwargs):
             sage: C.encoder('NonExistingEncoder')
             Traceback (most recent call last):
             ...
-            ValueError: There is no Encoder named 'NonExistingEncoder'. The known Encoders are: ['GeneratorMatrix', 'Systematic']
+            ValueError: There is no Encoder named 'NonExistingEncoder'.
+            The known Encoders are: ['GeneratorMatrix', 'Systematic']
 
         Some encoders take extra arguments. If the user incorrectly supplies
         these, the error message attempts to be helpful::
 
             sage: C.encoder('Systematic', strange_parameter=True)
             Traceback (most recent call last):
             ...
-            ValueError: Constructing the Systematic encoder failed, possibly due to missing or incorrect parameters.
-            The constructor requires no arguments.
-            It takes the optional arguments ['systematic_positions'].
-            See the documentation of sage.coding.linear_code_no_metric.LinearCodeSystematicEncoder for more details.
+            ValueError: Constructing the Systematic encoder failed,
+            possibly due to missing or incorrect parameters.
+            The constructor requires no arguments. It takes the optional
+            arguments ['systematic_positions']. See the documentation of
+            sage.coding.linear_code_no_metric.LinearCodeSystematicEncoder
+            for more details.
         """
         if not self._default_encoder_name:
             raise NotImplementedError("No encoder implemented for this code.")
@@ -1002,14 +1016,15 @@ def encoders_available(self, classes=False):
         INPUT:
 
         - ``classes`` -- (default: ``False``) if ``classes`` is set to ``True``,
-          return instead a ``dict`` mapping available encoder name to the
+          return instead a :class:`dict` mapping available encoder name to the
           associated encoder class.
 
-        OUTPUT: a list of strings, or a `dict` mapping strings to classes.
+        OUTPUT: a list of strings, or a :class:`dict` mapping strings to classes.
 
         EXAMPLES::
 
-            sage: G = Matrix(GF(2), [[1,1,1,0,0,0,0],[1,0,0,1,1,0,0],[0,1,0,1,0,1,0],[1,1,0,1,0,0,1]])
+            sage: G = Matrix(GF(2), [[1,1,1,0,0,0,0], [1,0,0,1,1,0,0],
+            ....:                    [0,1,0,1,0,1,0], [1,1,0,1,0,0,1]])
             sage: C = LinearCode(G)
             sage: C.encoders_available()
             ['GeneratorMatrix', 'Systematic']
@@ -1051,7 +1066,8 @@ def unencode(self, c, encoder_name=None, nocheck=False, **kwargs):
 
         EXAMPLES::
 
-            sage: G = Matrix(GF(2), [[1,1,1,0,0,0,0],[1,0,0,1,1,0,0],[0,1,0,1,0,1,0],[1,1,0,1,0,0,1]])
+            sage: G = Matrix(GF(2), [[1,1,1,0,0,0,0], [1,0,0,1,1,0,0],
+            ....:                    [0,1,0,1,0,1,0], [1,1,0,1,0,0,1]])
             sage: C = LinearCode(G)
             sage: c = vector(GF(2), (1, 1, 0, 0, 1, 1, 0))
             sage: C.unencode(c)

src/sage/coding/ag_code.py

@@ -1,3 +1,4 @@
+# sage.doctest: optional - sage.rings.finite_rings sage.schemes
 """
 AG codes
 
@@ -538,7 +539,8 @@ def basis_differentials(self):
             sage: Q, = C.places_at_infinity()
             sage: pls.remove(Q)
             sage: code = codes.DifferentialAGCode(pls, 3*Q)
-            sage: matrix([[w.residue(p) for p in pls] for w in code.basis_differentials()])
+            sage: matrix([[w.residue(p) for p in pls]
+            ....:         for w in code.basis_differentials()])
             [    1     0     0     0     0 a + 1 a + 1     1]
             [    0     1     0     0     0 a + 1     a     0]
             [    0     0     1     0     0     a     1     a]

src/sage/coding/ag_code_decoders.pyx

@@ -1,4 +1,4 @@
-# -*- coding: utf-8 -*-
+# sage.doctest: optional - sage.rings.finite_rings sage.schemes
 r"""
 Decoders for AG codes