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.

Title: docs for unittest.expectedFailure do not syntactically show it's a decorator
Type: enhancement Stage: needs patch
Components: Documentation Versions:
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: georg.brandl Nosy List: benjamin.peterson, brett.cannon, georg.brandl
Priority: low Keywords:

Created on 2009-07-20 01:15 by brett.cannon, last changed 2022-04-11 14:56 by admin. This issue is now closed.

Messages (2)
msg90718 - (view) Author: Brett Cannon (brett.cannon) * (Python committer) Date: 2009-07-20 01:15
If you look at the docs for the unittest.expectedFailure decorator you 
will notice it shows a set of empty parentheses since it is set with a 
function directive. But since it's a decorator those empty parentheses 
are not accurate.

If you want to view the docs as showing common usage -- like the docs 
for the other decorators in unittest -- then those empty parentheses 
need to go. An @ should also probably be added as well.

But if you view it more as how the decorator is called -- like with 
importlib.util.module_for_loader does -- then it should have an argument 
for the callable being passed in. This would also mean that all the 
other decorators in unittest need a second set of parentheses taking a 
callable as their argument as well.

Perhaps it's time we added a decorator directive that adds the @ sign 
and does not insert empty parentheses?
msg111956 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2010-07-29 16:01
Done in r83234.  Thanks for the suggestion!
Date User Action Args
2022-04-11 14:56:51adminsetgithub: 50771
2010-07-29 16:01:34georg.brandlsetstatus: open -> closed
resolution: fixed
messages: + msg111956
2009-07-20 13:27:50benjamin.petersonsetassignee: benjamin.peterson -> georg.brandl
2009-07-20 13:14:10benjamin.petersonsetassignee: georg.brandl -> benjamin.peterson

nosy: + benjamin.peterson
2009-07-20 01:15:09brett.cannoncreate