Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

"known issues" doctests should be run

See original GitHub issue

In https://github.com/astropy/astropy/pull/7834#discussion_r218922328, it was noted that the file known_issues.rst has all its doctests skipped. This seems a bad idea: we should in fact test that the issues still exist (i.e., that the examples given give the wrong answer) and that the workarounds work. In particular, I have some hope some of the issues will disappear with future numpy versions - the doctests will then give us a heads-up so that we can insert version numbers and eventually remove the text.

Issue Analytics

State:
Created 5 years ago
Reactions:2
Comments:9 (9 by maintainers)

Top GitHub Comments

1reaction

astrofrogcommented, Sep 21, 2018

One thing to note is that we’ll want to still keep a known issue even if it’s fixed in the very latest Numpy, since people may be slow to upgrade.

0reactions

astrofrogcommented, Oct 4, 2020

Looks like it!

Top Results From Across the Web

doctest — Test interactive Python examples — Python 3.11.1 ...

The doctest module searches for pieces of text that look like interactive Python sessions, and then executes those sessions to verify that they...

Run** should run doctests · Issue #4317 · rust-lang/rust-analyzer

I think doc tests outside of the --lib are a niche use-case to begin with, so I'd start with only supporting --doc and...

Handling common doctest issues | Modern Python Cookbook

Stipulate a value for the PYTHONHASHSEED environment variable; Require that Python be run with the -R option to disable hash randomization entirely. There...

Python's doctest: Document and Test Your Code at Once

Go ahead and run the following command: $ python -m doctest calculations.py. This command won't issue any output to your screen.

Things I don't like about doctest - Ned Batchelder

I know that doctest can be used independently of the actual docstrings in ... Even a small change in code compels me to...