This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: test_eightteen() in test_inspect out of sync with documentation
Type: Stage: resolved
Components: Documentation, Tests Versions: Python 3.6, Python 3.5
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: docs@python, martin.panter, python-dev, yselivanov
Priority: normal Keywords:

Created on 2015-07-01 01:42 by martin.panter, last changed 2022-04-11 14:58 by admin. This issue is now closed.

Messages (6)
msg246012 - (view) Author: Martin Panter (martin.panter) * (Python committer) Date: 2015-07-01 01:42
Revision 0b7c313851ca highlights an inconsistency in the test case at the top of the TestPredicates class. After removing isawaitable() in Issue 24400, there are now actually eighteen is* functions. The comment in the test case still says there are sixteen (from before the two iscoroutine* functions were added), and so does the documentation it references: ‘The sixteen functions whose names begin with “is” ’ <https://docs.python.org/3.5/library/inspect.html#types-and-members>. The quick fix is to change all the numbers to eighteen.

But maybe a better fix is to drop it all and rewrite the documentation to just say “The functions whose names begin with “is” are mainly provided . . .”.
msg246014 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2015-07-01 01:45
New changeset a5c6eaa7d733 by Yury Selivanov in branch '3.5':
Issue #24541: Update comment in test_inspect.test_eightteen
https://hg.python.org/cpython/rev/a5c6eaa7d733
msg246015 - (view) Author: Yury Selivanov (yselivanov) * (Python committer) Date: 2015-07-01 01:46
This has already been fix (see issue24400).  I've also updated the comment (16 -> 18).  Let's keep the test as is.
msg246016 - (view) Author: Martin Panter (martin.panter) * (Python committer) Date: 2015-07-01 01:55
Okay but what about the documentation? It still claims sixteen.

# This test is here for remember you to update Doc/library/inspect.rst
msg246018 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2015-07-01 02:07
New changeset bd45435fd081 by Yury Selivanov in branch '3.5':
Issue #24541: Drop test_inspect.test_eightteen unittest; update docs
https://hg.python.org/cpython/rev/bd45435fd081
msg246019 - (view) Author: Yury Selivanov (yselivanov) * (Python committer) Date: 2015-07-01 02:08
Thanks for pushing this Martin. I didn't notice that you suggested to update inspect.rst as well. And it does make sense to just remove the number of is* functions from the docs (and after that we don't need the unittest).
History
Date User Action Args
2022-04-11 14:58:18adminsetgithub: 68729
2015-07-01 02:08:56yselivanovsetmessages: + msg246019
2015-07-01 02:07:04python-devsetmessages: + msg246018
2015-07-01 01:55:33martin.pantersetmessages: + msg246016
2015-07-01 01:46:20yselivanovsetstatus: open -> closed

nosy: + yselivanov
messages: + msg246015

resolution: fixed
stage: resolved
2015-07-01 01:45:22python-devsetnosy: + python-dev
messages: + msg246014
2015-07-01 01:42:28martin.pantercreate