Skip to content

Commit 02b31cc

Browse files
author
Release Manager
committed
Trac #34170: Fix docstring markup in sage/coding
Part of #34157: {{{ sage/coding/gabidulin_code.py:534:1: RST218 Literal block expected; none found. sage/coding/ag_code.py:35:1: RST303 Unknown directive type "toctree". sage/coding/self_dual_codes.py:228:1: RST218 Literal block expected; none found. sage/coding/linear_code_no_metric.py:755:1: RST204 Enumerated list ends without a blank line; unexpected unindent. sage/coding/grs_code.py:1201:1: RST202 Bullet list ends without a blank line; unexpected unindent. sage/coding/grs_code.py:1201:1: RST213 Inline emphasis start-string without end-string. sage/coding/guruswami_sudan/interpolation.py:41:1: RST218 Literal block expected; none found. }}} URL: https://trac.sagemath.org/34170 Reported by: klee Ticket author(s): Frédéric Chapoton, Matthias Koeppe Reviewer(s): John Palmieri
2 parents 1da7752 + eeb6448 commit 02b31cc

File tree

6 files changed

+24
-21
lines changed

6 files changed

+24
-21
lines changed

src/sage/coding/gabidulin_code.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -530,9 +530,9 @@ class GabidulinPolynomialEvaluationEncoder(Encoder):
530530
531531
(p(\alpha_1), \dots, p(\alpha_n)).
532532
533-
TESTS::
533+
TESTS:
534534
535-
This module uses the following experimental feature:
535+
This module uses the following experimental feature.
536536
This test block is here only to trigger the experimental warning so it does not
537537
interferes with doctests::
538538

src/sage/coding/grs_code.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1199,7 +1199,7 @@ def _decode_to_code_and_message(self, r):
11991199
12001200
* ``c`` is the representation of ``r`` decoded in the ambient
12011201
space of the associated code of ``self``
1202-
*``f`` its representation in the message space of ``self``
1202+
* ``f`` its representation in the message space of ``self``
12031203
12041204
EXAMPLES::
12051205

src/sage/coding/guruswami_sudan/interpolation.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,10 +39,10 @@ def _flatten_once(lstlst):
3939
4040
EXAMPLES::
4141
42-
sage: from sage.coding.guruswami_sudan.interpolation import _flatten_once
43-
sage: ll = [[1,2], [3,4], [5,6]]
44-
sage: list(_flatten_once(ll))
45-
[1, 2, 3, 4, 5, 6]
42+
sage: from sage.coding.guruswami_sudan.interpolation import _flatten_once
43+
sage: ll = [[1,2], [3,4], [5,6]]
44+
sage: list(_flatten_once(ll))
45+
[1, 2, 3, 4, 5, 6]
4646
"""
4747
for lst in lstlst:
4848
for e in lst:

src/sage/coding/linear_code_no_metric.py

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -753,10 +753,12 @@ def __getitem__(self, i):
753753
``[(i*a^0 +(p-1)*a^1 +...+ (p-1)*a^(m-1))*G[0] for i in range(p)]``
754754
4. Then, we move to G[1]:
755755
``[i*a^0 * G[0] + a^0*G[1] for i in range(p)]``,
756-
and so on.
757-
Hence the `i`-th element can be obtained by the p-adic expansion
758-
of `i` as ``[i_0, i_1, ...,i_{m-1}, i_m, i_{m+1}, ..., i_{km-1}].``
759-
The element that is generated is:
756+
757+
and so on.
758+
Hence the `i`-th element can be obtained by the p-adic expansion
759+
of `i` as ``[i_0, i_1, ...,i_{m-1}, i_m, i_{m+1}, ..., i_{km-1}].``
760+
761+
The element that is generated is:
760762
761763
.. MATH::
762764

src/sage/coding/self_dual_codes.py

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -226,16 +226,16 @@ def _H8():
226226
227227
EXAMPLES::
228228
229-
sage: from sage.coding.self_dual_codes import _H8
230-
sage: _H8()
231-
[ 1 1 1 1 1 1 1 1]
232-
[ 1 -1 1 -1 1 -1 1 -1]
233-
[ 1 1 -1 -1 1 1 -1 -1]
234-
[ 1 -1 -1 1 1 -1 -1 1]
235-
[ 1 1 1 1 -1 -1 -1 -1]
236-
[ 1 -1 1 -1 -1 1 -1 1]
237-
[ 1 1 -1 -1 -1 -1 1 1]
238-
[ 1 -1 -1 1 -1 1 1 -1]
229+
sage: from sage.coding.self_dual_codes import _H8
230+
sage: _H8()
231+
[ 1 1 1 1 1 1 1 1]
232+
[ 1 -1 1 -1 1 -1 1 -1]
233+
[ 1 1 -1 -1 1 1 -1 -1]
234+
[ 1 -1 -1 1 1 -1 -1 1]
235+
[ 1 1 1 1 -1 -1 -1 -1]
236+
[ 1 -1 1 -1 -1 1 -1 1]
237+
[ 1 1 -1 -1 -1 -1 1 1]
238+
[ 1 -1 -1 1 -1 1 1 -1]
239239
"""
240240
return matrix(ZZ, [[1, 1, 1, 1, 1, 1, 1, 1],\
241241
[1, -1, 1, -1, 1, -1, 1, -1],\

src/tox.ini

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -209,6 +209,7 @@ rst-roles =
209209
rst-directives =
210210
automethod,
211211
autofunction,
212+
toctree,
212213
MODULEAUTHOR,
213214
ONLY,
214215
PLOT,

0 commit comments

Comments
 (0)