QuantEcon / QuantEcon.py / 34419685647
94%

DEFAULT BRANCH: main
Ran
Jobs 1
Files 94
Run time 1min
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst
coverage: 93.967% (+3.1%) from 90.9%
34419685647

push

github

web-flow 
TEST: run docstring examples without comparing output (#866) (#920)

* CI: Run docstring examples via pytest --doctest-modules

Wires the docstring-example sweep from gh-866 into ci.yml so examples
cannot silently rot again after the gh-864 fixes.

A new quantecon/conftest.py resolves the two blockers raised in gh-866:

- An autouse fixture restores NumPy print options after each test, so
  the game_theory examples that set precision=4 no longer leak
  process-global state into doctests collected later (previously 8
  spurious failures in markov, optimize and random).
- collect_ignore excludes util/notebooks.py (fetches over the network)
  and util/timing.py (prints wall-clock durations), keeping the
  rendered docs free of `# doctest: +SKIP` directives.

The CI step runs on Linux only: one platform is enough to stop drift,
and it sidesteps --ignore-glob path-separator issues on Windows. The
DeprecationWarning from util/array.py::searchsorted needs no handling
since no strict warning filter is configured.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* CI: move doctest conftest.py to the repository root

qe_apidoc.py discovers Tools pages by globbing quantecon/[a-z0-9]*.py,
so an in-package conftest.py would be picked up as a public module and
fail the docs-drift check; the root location also keeps a module that
imports pytest out of the installed wheel.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* TEST: run docstring examples without comparing output

Replaces the `--doctest-modules` CI step and its root `conftest.py` with
a single test that executes every docstring example and checks only that
it does not raise.

Comparing example output is what made the previous design need
machinery. Global NumPy print options leak between modules, causing nine
spurious failures, and two modules could not pass verbatim at all.
Neither applies once output is not compared: leaked print options are
invisible, and `util/timing.py`'s wall-clock... (continued)

5483 of 5835 relevant lines covered (93.97%)

0.94 hits per line

Jobs
ID Job ID Ran Files Coverage
1 34419685647.1 94
93.97
 GitHub Action Run
Source Files on build 34419685647