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

A follow up to be4e5b8920.
This commit is contained in:
Benjamin Peterson 2018-10-02 21:38:39 -07:00 committed by GitHub
parent 97bfe8d3eb
commit e006b39a40
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 3 deletions

View File

@ -984,7 +984,7 @@ Test cases
.. method:: assertRaisesRegex(exception, regex, callable, *args, **kwds) .. 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 Like :meth:`assertRaises` but also tests that *regex* matches
on the string representation of the raised exception. *regex* may be on the string representation of the raised exception. *regex* may be
@ -1010,7 +1010,7 @@ Test cases
.. method:: assertWarns(warning, callable, *args, **kwds) .. 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 Test that a warning is triggered when *callable* is called with any
positional or keyword arguments that are also passed to positional or keyword arguments that are also passed to
@ -1051,7 +1051,7 @@ Test cases
.. method:: assertWarnsRegex(warning, regex, callable, *args, **kwds) .. 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 Like :meth:`assertWarns` but also tests that *regex* matches on the
message of the triggered warning. *regex* may be a regular expression message of the triggered warning. *regex* may be a regular expression