src/sage/groups/perm_gps: Fix formatting of doctest tags

Author: Matthias Koeppe

src/sage/groups/perm_gps/permgroup.py

@@ -164,7 +164,7 @@ def load_hap():
 
     EXAMPLES::
 
-        sage: sage.groups.perm_gps.permgroup.load_hap() # optional - gap_package_hap
+        sage: sage.groups.perm_gps.permgroup.load_hap()         # optional - gap_package_hap
     """
     from sage.features.gap import GapPackage
     GapPackage("hap", spkg="gap_packages").require()
@@ -179,16 +179,17 @@ def hap_decorator(f):
 
     EXAMPLES::
 
+        sage: # optional - gap_package_hap
         sage: from sage.groups.perm_gps.permgroup import hap_decorator
         sage: def foo(self, n, p=0): print("Done")
         sage: foo = hap_decorator(foo)
-        sage: foo(None, 3)    #optional - gap_package_hap
+        sage: foo(None, 3)
         Done
-        sage: foo(None, 3, 0) # optional - gap_package_hap
+        sage: foo(None, 3, 0)
         Done
-        sage: foo(None, 3, 5) # optional - gap_package_hap
+        sage: foo(None, 3, 5)
         Done
-        sage: foo(None, 3, 4) #optional - gap_package_hap
+        sage: foo(None, 3, 4)
         Traceback (most recent call last):
         ...
         ValueError: p must be 0 or prime

src/sage/groups/perm_gps/permgroup_named.py

@@ -134,7 +134,7 @@ def __classcall__(cls, *args, **kwds):
 
         EXAMPLES::
 
-            sage: SymmetricGroup(['a','b']).domain() #indirect doctest
+            sage: SymmetricGroup(['a','b']).domain()  # indirect doctest
             {'a', 'b'}
         """
         domain = kwds.pop('domain', None)
@@ -679,7 +679,7 @@ def __init__(self, domain=None):
             Alternating group of order 6!/2 as a permutation group
             sage: G.category()
             Category of finite enumerated permutation groups
-            sage: TestSuite(G).run() # long time
+            sage: TestSuite(G).run()  # long time
 
             sage: G = AlternatingGroup([1,2,4,5])
             sage: G
@@ -1063,14 +1063,15 @@ def __init__(self, n):
 
         EXAMPLES::
 
-            sage: G = groups.permutation.Janko(1); G # optional - gap_package_atlasrep internet
+            sage: G = groups.permutation.Janko(1); G                            # optional - gap_package_atlasrep internet
             Janko group J1 of order 175560 as a permutation group
 
         TESTS::
 
-            sage: G.category() # optional - gap_package_atlasrep internet
+            sage: G.category()                                                  # optional - gap_package_atlasrep internet
             Category of finite enumerated permutation groups
-            sage: TestSuite(G).run(skip=["_test_enumerated_set_contains", "_test_enumerated_set_iter_list"]) # optional - gap_package_atlasrep internet
+            sage: TestSuite(G).run(skip=["_test_enumerated_set_contains",       # optional - gap_package_atlasrep internet
+            ....:                        "_test_enumerated_set_iter_list"])
         """
         if n not in [1, 2, 3]:
             raise ValueError("n must belong to {1,2,3}")
@@ -1083,7 +1084,7 @@ def _repr_(self):
         """
         EXAMPLES::
 
-            sage: G = groups.permutation.Janko(1); G # optional - gap_package_atlasrep internet
+            sage: G = groups.permutation.Janko(1); G                            # optional - gap_package_atlasrep internet
             Janko group J1 of order 175560 as a permutation group
         """
         return "Janko group J%s of order %s as a permutation group" % (self._n, self.order())
@@ -1096,14 +1097,15 @@ def __init__(self):
 
         EXAMPLES::
 
-            sage: G = groups.permutation.SuzukiSporadic(); G # optional - gap_package_atlasrep internet
+            sage: G = groups.permutation.SuzukiSporadic(); G                    # optional - gap_package_atlasrep internet
             Sporadic Suzuki group acting on 1782 points
 
         TESTS::
 
             sage: G.category() # optional - gap_package_atlasrep internet
             Category of finite enumerated permutation groups
-            sage: TestSuite(G).run(skip=["_test_enumerated_set_contains", "_test_enumerated_set_iter_list"]) # optional - gap_package_atlasrep internet
+            sage: TestSuite(G).run(skip=["_test_enumerated_set_contains",       # optional - gap_package_atlasrep internet
+            ....:                        "_test_enumerated_set_iter_list"])
         """
         libgap.load_package("atlasrep")
         PermutationGroup_generic.__init__(self, gap_group='AtlasGroup("Suz")')
@@ -1112,7 +1114,7 @@ def _repr_(self):
         """
         EXAMPLES::
 
-            sage: G = groups.permutation.SuzukiSporadic(); G # optional - gap_package_atlasrep internet
+            sage: G = groups.permutation.SuzukiSporadic(); G                    # optional - gap_package_atlasrep internet
             Sporadic Suzuki group acting on 1782 points
         """
         return "Sporadic Suzuki group acting on 1782 points"
@@ -1987,7 +1989,7 @@ def _repr_(self):
         """
         TESTS::
 
-            sage: TransitiveGroups() # indirect doctest
+            sage: TransitiveGroups()  # indirect doctest
             Transitive Groups
         """
         return "Transitive Groups"
@@ -2101,7 +2103,7 @@ def __iter__(self):
         """
         EXAMPLES::
 
-            sage: list(TransitiveGroups(5)) # indirect doctest
+            sage: list(TransitiveGroups(5))  # indirect doctest
             [Transitive group number 1 of degree 5,
              Transitive group number 2 of degree 5,
              Transitive group number 3 of degree 5,
@@ -2375,7 +2377,7 @@ class PrimitiveGroupsAll(DisjointUnionEnumeratedSets):
 
     The following test is broken, see :trac:`22576`::
 
-        sage: TestSuite(PrimitiveGroups()).run() # known bug # long time
+        sage: TestSuite(PrimitiveGroups()).run()  # known bug, long time
     """
     def __init__(self):
         """
@@ -2399,7 +2401,7 @@ def _repr_(self):
 
         TESTS::
 
-            sage: PrimitiveGroups() # indirect doctest
+            sage: PrimitiveGroups()  # indirect doctest
             Primitive Groups
         """
         return "Primitive Groups"
@@ -2533,7 +2535,7 @@ def __iter__(self):
         """
         EXAMPLES::
 
-            sage: list(PrimitiveGroups(5)) # indirect doctest
+            sage: list(PrimitiveGroups(5))  # indirect doctest
             [C(5), D(2*5), AGL(1, 5), A(5), S(5)]
         """
         for n in range(1, self.cardinality() + 1):
@@ -2650,7 +2652,7 @@ def __init__(self, n, q, name='a'):
 
             sage: G.category()
             Category of finite enumerated permutation groups
-            sage: TestSuite(G).run() # long time
+            sage: TestSuite(G).run()  # long time
 
         TESTS::
 
@@ -2718,7 +2720,7 @@ def __init__(self, n, q, name='a'):
 
             sage: G.category()
             Category of finite enumerated permutation groups
-            sage: TestSuite(G).run() # long time
+            sage: TestSuite(G).run()  # long time
 
         TESTS::
 
@@ -2784,7 +2786,7 @@ def ramification_module_decomposition_hurwitz_curve(self):
         EXAMPLES::
 
             sage: G = PSL(2,13)
-            sage: G.ramification_module_decomposition_hurwitz_curve() # random, optional - gap_packages
+            sage: G.ramification_module_decomposition_hurwitz_curve()  # random, optional - gap_packages
             [0, 7, 7, 12, 12, 12, 13, 15, 14]
 
         This means, for example, that the trivial representation does not
@@ -2834,7 +2836,7 @@ def ramification_module_decomposition_modular_curve(self):
         EXAMPLES::
 
             sage: G = PSL(2,7)
-            sage: G.ramification_module_decomposition_modular_curve() # random, optional - gap_packages
+            sage: G.ramification_module_decomposition_modular_curve()  # random, optional - gap_packages
             [0, 4, 3, 6, 7, 8]
 
         This means, for example, that the trivial representation does not