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

Remove "#doctest: +SKIP" comments on valid docstrings #6572

Open
jrioux opened this Issue Nov 1, 2012 · 7 comments

Comments

Projects
None yet
6 participants
@jrioux
Copy link
Member

jrioux commented Nov 1, 2012

In docstrings, we have examples from a python prompt, with input and output, e.g.

>>> x + x
2*x

The command bin/doctest is used to check that the output is consistent with the input. We sometimes have

>>> x + x  #doctest: +SKIP
3*x

Such a comment means that the docstring tester is not required to check the consistency of input/output. It is expected that the test fails even though, quite often, in an ideal world, it should really pass. As development continues, it's possible for the test to become valid and pass without the programmer removing the "#doctest: +SKIP" comment, perhaps because it wasn't noticed. One should investigate which docstring with "#doctest: +SKIP" comments are really valid and passing docstrings under all architecture, and remove the "#doctest: +SKIP" comment in those docstrings.

Original issue for #6572: http://code.google.com/p/sympy/issues/detail?id=3473
Original author: https://code.google.com/u/102137482174297837682/

@jrioux

This comment has been minimized.

Copy link
Member

jrioux commented Oct 31, 2012

@asmeurer

This comment has been minimized.

Copy link
Member

asmeurer commented Nov 8, 2012

**Labels:** CodeInImportedIntoGoogleDocs  

Original comment: http://code.google.com/p/sympy/issues/detail?id=3473#c2
Original author: https://code.google.com/u/asmeurer@gmail.com/

@jrioux jrioux added imported labels Mar 7, 2014

@flacjacket flacjacket added Easy to Fix and removed EasyToFix labels Mar 7, 2014

@mickyaero

This comment has been minimized.

Copy link
Contributor

mickyaero commented Sep 11, 2016

In file sympy/sympy/functions/elementary/miscellaneous.py
It has the docstring

Min(x, y) #doctest: +SKIP
Min(x, y)

But as the test is always true, we have to remove the "#doctest: +SKIP".
Have I got this right?
If yes i would like to work on this bug

@asmeurer

This comment has been minimized.

Copy link
Member

asmeurer commented Sep 12, 2016

Maybe it is skipped because it could print as Min(x, y) or Min(y, x).

@thisch

This comment has been minimized.

Copy link
Contributor

thisch commented Sep 14, 2016

Try to create a PR and check if the unit-tests pass.

@mickyaero

This comment has been minimized.

Copy link
Contributor

mickyaero commented Sep 15, 2016

#11616

All tests are passing.
Am i on the right track?

asmeurer added a commit that referenced this issue Sep 15, 2016

Merge pull request #11616 from mickyaero/master
Remove "#doctest: +SKIP" comments on valid docstrings #6572

skirpichev added a commit to skirpichev/diofant that referenced this issue Sep 17, 2016

@mickyaero

This comment has been minimized.

Copy link
Contributor

mickyaero commented Sep 18, 2016

#11625
All tests are passing

skirpichev added a commit to skirpichev/diofant that referenced this issue Sep 20, 2016

skirpichev added a commit to skirpichev/diofant that referenced this issue Sep 21, 2016

Remove "doctest: +SKIP" for valid docstrings
Closes sympy/sympy#6572

Rest of skipped docstrings - random tests and
warnings in the exceptions.py.

skirpichev added a commit to skirpichev/diofant that referenced this issue Sep 22, 2016

Remove "doctest: +SKIP" for valid docstrings
Closes sympy/sympy#6572

Rest of skipped docstrings - random tests, warnings in
the exceptions.py and autowrap stuff in autowrap.rst.

skirpichev added a commit to skirpichev/diofant that referenced this issue Sep 23, 2016

Remove "doctest: +SKIP" for valid docstrings
Closes sympy/sympy#6572

Rest of skipped docstrings - random tests, warnings in
the exceptions.py and autowrap stuff in autowrap.rst.

skirpichev added a commit to skirpichev/diofant that referenced this issue Sep 24, 2016

Remove "doctest: +SKIP" for valid docstrings
Closes sympy/sympy#6572

Rest of skipped docstrings - random tests, warnings in
the exceptions.py and autowrap stuff in autowrap.rst.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment