doc: improve warning_record_to_str

2019-03-24 11:20:01 +01:00
parent 6352cf2374
commit d44e42ec15
1 changed files with 2 additions and 1 deletions
--- a/src/_pytest/warnings.py
+++ b/src/_pytest/warnings.py
@@ -103,8 +103,9 @@ def catch_warnings_for_item(config, ihook, when, item):


 def warning_record_to_str(warning_message):
-    """Convert a warnings.WarningMessage to a string, taking in account a lot of unicode shenaningans in Python 2.
+    """Convert a warnings.WarningMessage to a string.

+    This takes lot of unicode shenaningans into account for Python 2.
    When Python 2 support is dropped this function can be greatly simplified.
    """
    warn_msg = warning_message.message