Skip to content

Commit

Permalink
Trac #34166: Fix docstring markup in sage/tests except sage/tests/boo…
Browse files Browse the repository at this point in the history
…k_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
  • Loading branch information
Release Manager committed Jul 25, 2022
2 parents 6e41b53 + 24e01a2 commit e9be172
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 11 deletions.
12 changes: 7 additions & 5 deletions src/sage/tests/article_heuberger_krenn_kropf_fsm-in-sage.py
Original file line number Diff line number Diff line change
@@ -1,16 +1,18 @@
r"""
This file contains doctests of the article
This file contains doctests of the article ::
Automata and Transducers
in the Computer Algebra System Sage
by Clemens Heuberger, Daniel Krenn, and Sara Kropf, :arxiv:`1404.7458`.
IF IT BECOMES NECESSARY TO CHANGE ANY TESTS IN THIS FILE, THERE
NEEDS TO BE A ONE-YEAR DEPRECATION PERIOD. ALSO, PLEASE INFORM
Clemens Heuberger <[email protected]>,
Daniel Krenn <[email protected]>, AND
Sara Kropf <[email protected]>
NEEDS TO BE A ONE-YEAR DEPRECATION PERIOD. ALSO, PLEASE INFORM:
- Clemens Heuberger <[email protected]>,
- Daniel Krenn <[email protected]>, AND
- Sara Kropf <[email protected]>
IN THIS CASE REGARDING THE CHANGES!
"""

Expand Down
16 changes: 10 additions & 6 deletions src/sage/tests/benchmark.py
Original file line number Diff line number Diff line change
Expand Up @@ -64,12 +64,16 @@ def run(self, systems=None, timeout=60, trials=1, sort=False, optional=False):
given.
INPUT:
systems -- list of strings of which systems to run tests on
if None, runs the standard systems
timeout -- how long (in seconds) to run each test for
trials -- integer, number of trials
sort -- whether to sort system names
optional -- if systems is None, whether to test optional systems
- systems -- optional list of strings of which systems to run tests on;
if ``None``, runs the standard systems
- timeout -- optional integer (default 60); how long (in seconds)
to run each test for
- trials -- optional integer (default 1); number of trials
- sort -- optional boolean (default ``False``); whether to sort
system names
- optional -- optional boolean (default ``False``);
if systems is ``None``, whether to test optional systems
EXAMPLES::
Expand Down
2 changes: 2 additions & 0 deletions src/sage/tests/gosper-sum.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
"""
Some tests about Gosper sums.
References
==========
Expand Down

0 comments on commit e9be172

Please sign in to comment.