Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

tutorials fail doctests #2424

Closed
mpenkov opened this issue Mar 20, 2019 · 0 comments · Fixed by #2591
Closed

tutorials fail doctests #2424

mpenkov opened this issue Mar 20, 2019 · 0 comments · Fixed by #2591
Assignees
Labels
bug Issue described a bug documentation Current issue related to documentation impact LOW Low impact on affected users reach LOW Affects only niche use-case users

Comments

@mpenkov
Copy link
Collaborator

mpenkov commented Mar 20, 2019

If you run "python -m doctest docs/src/tut1.rst" you get a ton of output. Most of the problems are because of incorrect formatting, e.g.

>>> x = [1,
>>>      2]

should really be:

>>> x = [1,
...      2]

For whatever reason, it doesn't look like the tutorials were ever tested with doctest. There's no reason for it to be this way, so we should make them doctest-compatible in the future.

@mpenkov mpenkov added bug Issue described a bug documentation Current issue related to documentation labels Mar 20, 2019
@mpenkov mpenkov self-assigned this Mar 20, 2019
@piskvorky piskvorky added reach LOW Affects only niche use-case users impact LOW Low impact on affected users labels Oct 8, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Issue described a bug documentation Current issue related to documentation impact LOW Low impact on affected users reach LOW Affects only niche use-case users
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants