]> granicus.if.org Git - python/commitdiff
Improve some docstrings in the 'warnings' module.
authorNeil Schemenauer <nascheme@enme.ucalgary.ca>
Fri, 23 Oct 2009 19:58:17 +0000 (19:58 +0000)
committerNeil Schemenauer <nascheme@enme.ucalgary.ca>
Fri, 23 Oct 2009 19:58:17 +0000 (19:58 +0000)
Lib/warnings.py

index 14466d3ba0196df4348d5a97595b9edd8fc8e17a..8d46cd68df6b8a5ba84e0865503b4692041ddaa7 100644 (file)
@@ -46,7 +46,14 @@ def filterwarnings(action, message="", category=Warning, module="", lineno=0,
                    append=0):
     """Insert an entry into the list of warnings filters (at the front).
 
-    Use assertions to check that all arguments have the right type."""
+    'action' -- one of "error", "ignore", "always", "default", "module",
+                or "once"
+    'message' -- a regex that the warning message must match
+    'category' -- a class that the warning must be a subclass of
+    'module' -- a regex that the module name must match
+    'lineno' -- an integer line number, 0 matches all warnings
+    'append' -- if true, append to the list of filters
+    """
     import re
     assert action in ("error", "ignore", "always", "default", "module",
                       "once"), "invalid action: %r" % (action,)
@@ -68,6 +75,11 @@ def simplefilter(action, category=Warning, lineno=0, append=0):
     """Insert a simple entry into the list of warnings filters (at the front).
 
     A simple filter matches all modules and messages.
+    'action' -- one of "error", "ignore", "always", "default", "module",
+                or "once"
+    'category' -- a class that the warning must be a subclass of
+    'lineno' -- an integer line number, 0 matches all warnings
+    'append' -- if true, append to the list of filters
     """
     assert action in ("error", "ignore", "always", "default", "module",
                       "once"), "invalid action: %r" % (action,)