[Python-checkins] Make it clear that the msg argument to assertWarns/assertWarnsRegex/assertRaisesRegex is keyword-only. (GH-9680)

Miss Islington (bot) webhook-mailer at python.org
Wed Oct 3 00:44:27 EDT 2018


https://github.com/python/cpython/commit/f1e8be70a635995e67230b7eb73b08c442d886f8
commit: f1e8be70a635995e67230b7eb73b08c442d886f8
branch: 3.6
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: GitHub <noreply at github.com>
date: 2018-10-02T21:44:18-07:00
summary:

Make it clear that the msg argument to assertWarns/assertWarnsRegex/assertRaisesRegex is keyword-only. (GH-9680)


A follow up to be4e5b89204283a62e369439025f00362d0424f6.
(cherry picked from commit e006b39a40e0cd6a90c68f1107853ea2ed0ed54d)

Co-authored-by: Benjamin Peterson <benjamin at python.org>

files:
M Doc/library/unittest.rst

diff --git a/Doc/library/unittest.rst b/Doc/library/unittest.rst
index 17deeddd37d1..dd85e9e33d9c 100644
--- a/Doc/library/unittest.rst
+++ b/Doc/library/unittest.rst
@@ -965,7 +965,7 @@ Test cases
 
 
    .. method:: assertRaisesRegex(exception, regex, callable, *args, **kwds)
-               assertRaisesRegex(exception, regex, msg=None)
+               assertRaisesRegex(exception, regex, *, msg=None)
 
       Like :meth:`assertRaises` but also tests that *regex* matches
       on the string representation of the raised exception.  *regex* may be
@@ -991,7 +991,7 @@ Test cases
 
 
    .. method:: assertWarns(warning, callable, *args, **kwds)
-               assertWarns(warning, msg=None)
+               assertWarns(warning, *, msg=None)
 
       Test that a warning is triggered when *callable* is called with any
       positional or keyword arguments that are also passed to
@@ -1032,7 +1032,7 @@ Test cases
 
 
    .. method:: assertWarnsRegex(warning, regex, callable, *args, **kwds)
-               assertWarnsRegex(warning, regex, msg=None)
+               assertWarnsRegex(warning, regex, *, msg=None)
 
       Like :meth:`assertWarns` but also tests that *regex* matches on the
       message of the triggered warning.  *regex* may be a regular expression



More information about the Python-checkins mailing list