Skip to content

Commit e9be172

Browse files
author
Release Manager
committed
Trac #34166: Fix docstring markup in sage/tests except sage/tests/book_stein_modform.py
Part of #34157: {{{ sage/tests/benchmark.py:68:1: RST203 Definition list ends without a blank line; unexpected unindent. sage/tests/article_heuberger_krenn_kropf_fsm-in-sage.py:10:1: RST301 Unexpected indentation. sage/tests/article_heuberger_krenn_kropf_fsm-in-sage.py:13:1: RST201 Block quote ends without a blank line; unexpected unindent. sage/tests/gosper-sum.py:2:1: RST399 Document or section may not begin with a transition. }}} URL: https://trac.sagemath.org/34166 Reported by: klee Ticket author(s): Frédéric Chapoton Reviewer(s): Matthias Koeppe
2 parents 6e41b53 + 24e01a2 commit e9be172

File tree

3 files changed

+19
-11
lines changed

3 files changed

+19
-11
lines changed

src/sage/tests/article_heuberger_krenn_kropf_fsm-in-sage.py

+7-5
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,18 @@
11
r"""
2-
This file contains doctests of the article
2+
This file contains doctests of the article ::
33
44
Automata and Transducers
55
in the Computer Algebra System Sage
66
77
by Clemens Heuberger, Daniel Krenn, and Sara Kropf, :arxiv:`1404.7458`.
88
99
IF IT BECOMES NECESSARY TO CHANGE ANY TESTS IN THIS FILE, THERE
10-
NEEDS TO BE A ONE-YEAR DEPRECATION PERIOD. ALSO, PLEASE INFORM
11-
Clemens Heuberger <[email protected]>,
12-
Daniel Krenn <[email protected]>, AND
13-
Sara Kropf <[email protected]>
10+
NEEDS TO BE A ONE-YEAR DEPRECATION PERIOD. ALSO, PLEASE INFORM:
11+
12+
- Clemens Heuberger <[email protected]>,
13+
- Daniel Krenn <[email protected]>, AND
14+
- Sara Kropf <[email protected]>
15+
1416
IN THIS CASE REGARDING THE CHANGES!
1517
"""
1618

src/sage/tests/benchmark.py

+10-6
Original file line numberDiff line numberDiff line change
@@ -64,12 +64,16 @@ def run(self, systems=None, timeout=60, trials=1, sort=False, optional=False):
6464
given.
6565
6666
INPUT:
67-
systems -- list of strings of which systems to run tests on
68-
if None, runs the standard systems
69-
timeout -- how long (in seconds) to run each test for
70-
trials -- integer, number of trials
71-
sort -- whether to sort system names
72-
optional -- if systems is None, whether to test optional systems
67+
68+
- systems -- optional list of strings of which systems to run tests on;
69+
if ``None``, runs the standard systems
70+
- timeout -- optional integer (default 60); how long (in seconds)
71+
to run each test for
72+
- trials -- optional integer (default 1); number of trials
73+
- sort -- optional boolean (default ``False``); whether to sort
74+
system names
75+
- optional -- optional boolean (default ``False``);
76+
if systems is ``None``, whether to test optional systems
7377
7478
EXAMPLES::
7579

src/sage/tests/gosper-sum.py

+2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
"""
2+
Some tests about Gosper sums.
3+
24
References
35
==========
46

0 commit comments

Comments
 (0)