[issue17329] Document unittest.SkipTest

[Ezio Melotti]

Ezio Melotti added the comment:

Fixed, thanks for the patch!

--
resolution:  -> fixed
stage: needs patch -> committed/rejected
status: open -> closed

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue17329] Document unittest.SkipTest

[Roundup Robot]

Roundup Robot added the comment:

New changeset cd5c23583fa5 by Ezio Melotti in branch '3.2':
#17329: document unittest.SkipTest.  Initial patch by Zachary Ware.
http://hg.python.org/cpython/rev/cd5c23583fa5

New changeset 4bf2a53b53b6 by Ezio Melotti in branch '3.3':
#17329: merge with 3.2.
http://hg.python.org/cpython/rev/4bf2a53b53b6

New changeset 53cc3dbb1918 by Ezio Melotti in branch 'default':
#17329: merge with 3.3.
http://hg.python.org/cpython/rev/53cc3dbb1918

New changeset 13eb2fd70893 by Ezio Melotti in branch '2.7':
#17329: document unittest.SkipTest.  Initial patch by Zachary Ware.
http://hg.python.org/cpython/rev/13eb2fd70893

--
nosy: +python-dev

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue17329] Document unittest.SkipTest

[Michael Foord]

Michael Foord added the comment:

For features like test skipping I would prefer to keep all the documentation 
together.

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue17329] Document unittest.SkipTest

[Ezio Melotti]

Ezio Melotti added the comment:

Now I get what you were trying to do.
What I don't like is that now the patch splits the section about skipping in 
two separate parts, while it would be better to keep it together IMHO.
You argument about having the "theory" first and the actual API later makes 
sense, and it's somewhat mirrored by e.g. the "basic example" section and the 
detailed API about TestCase and the assert methods later.
If we keep the two parts together we are left with two options:
1) add SkipTest to the existing section as I suggested initially;
2) move the whole section down below where the API is described;

1) it's simpler and it's enough IMHO, but if 2) is better I think it would be 
better to move it after the "deprecated aliases" section.

Michael, do you have any preference?

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue17329] Document unittest.SkipTest

[Ezio Melotti]

Changes by Ezio Melotti :


--
assignee: docs@python -> ezio.melotti

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue17329] Document unittest.SkipTest

[Zachary Ware]

Zachary Ware added the comment:

Fair points.  I had originally put it in the section you suggested, but then 
decided that it better fit in a new section of its own under "Classes and 
functions" as that section "describes in depth the API of unittest."  But then, 
it also makes sense to move the decorators into the new section, and just link 
to them in the old section.

So, how about this patch?  I'm fine with moving everything back to the old 
section if I've gone in the wrong direction :).  And I'll create the 2.7 patch 
after the 3.x version is approved one way or the other.

--
Added file: http://bugs.python.org/file29328/issue17329.v2.diff

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue17329] Document unittest.SkipTest

[Ezio Melotti]

Ezio Melotti added the comment:

> I wonder if that was meant to be TestCase.skipTest()?

Most likely.

I would document this exception at the end of the "Skipping tests and expected 
failures".  You could documented it simply as "the exception raised by the skip 
decorators", and suggest to use TestCase.skipTest() to skip a test rather than 
just raising this exception directly.

I'm also not sure if the note should be kept -- it seems quite obvious to me 
that the test will be marked as skipped even if previous assertions succeeded.  
Moreover, if the exception is generally not supposed to be used directly 
there's no need to explain how to use it.

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue17329] Document unittest.SkipTest

[Zachary Ware]

Zachary Ware added the comment:

In the patches, the description of SkipTest is copied directly from the 
docstring in Lib/unittest/case.py with a bit of markup added.  It mentions 
TestResult.skip(), which doesn't exist.  I wonder if that was meant to be 
TestCase.skipTest()?

--
type:  -> enhancement
versions: +Python 2.7, Python 3.2

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue17329] Document unittest.SkipTest

[Zachary Ware]

Changes by Zachary Ware :


Added file: http://bugs.python.org/file29319/issue17329-2.7.diff

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue17329] Document unittest.SkipTest

[Zachary Ware]

Zachary Ware added the comment:

Here's a pair of patches for 3.x and 2.7.  The 3.x patch is actually targeted 
at default; it has a couple extra instances of ``SkipTest`` that are converted 
to :exc:`SkipTest` in the patch.

--
keywords: +patch
versions: +Python 3.3
Added file: http://bugs.python.org/file29318/issue17329.diff

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue17329] Document unittest.SkipTest

[Brett Cannon]

New submission from Brett Cannon:



--
assignee: docs@python
components: Documentation
messages: 183262
nosy: brett.cannon, docs@python, ezio.melotti, michael.foord, zach.ware
priority: normal
severity: normal
stage: needs patch
status: open
title: Document unittest.SkipTest
versions: Python 3.4

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com