-
-
Notifications
You must be signed in to change notification settings - Fork 654
Closed
Milestone
Description
(from #30410)
As of #30503, sage -advanced
shows:
Testing files:
-t [options] <files|dir> -- test examples in .py, .pyx, .sage
or .tex files. Options:
--long -- include lines with the phrase 'long time'
...
--tox [options] <files|dirs> -- general entry point for testing
and linting of the Sage library
-e <envlist> -- run specific test environments (default: run all)
doctest -- run the Sage doctester
(same as "sage -t")
coverage -- give information about doctest coverage of files
(same as "sage --coverage[all]")
startuptime -- display how long each component of Sage takes to start up
(same as "sage --startuptime")
pycodestyle -- check against the Python style conventions of PEP8
relint -- check whether some forbidden patterns appear
(includes all patchbot pattern-exclusion plugins)
codespell -- check for misspelled words in source code
-p auto -- run test environments in parallel
--help -- show tox help
In this ticket, we expand the section in the developers' guide added in #30361 to cover these tools, expanding upon https://wiki.sagemath.org/ReleaseTours/sage-9.2#Testing_and_linting_with_tox
See also:
- Mention .lgtm.yml in the Developer's Guide #29520 Mention
.lgtm.yml
in the Developer's Guide - src/tox.ini: Add validation of docstrings using flake8-rst-docstrings #30448
src/tox.ini
: Add validation of rst files and docstrings - Meta-ticket: Adopt mainstream Python testing/linting infrastructure: tox, pytest, ..., describe in Developer's Guide #28936 Meta-ticket: Adopt mainstream Python testing/linting infrastructure, describe in Developer's Guide
- src/tox.ini: Add flake8 #30573
src/tox.ini
: Add flake8
Depends on #32899
CC: @dimpase @tobiasdiez @fchapoton @jhpalmieri @slel @yuan-zhou
Component: documentation
Author: Matthias Koeppe
Branch/Commit: 4632eb3
Reviewer: Dima Pasechnik, Tobias Diez
Issue created by migration from https://trac.sagemath.org/ticket/30453