Fixes for Add clear and other parameter docs to assert_produces_warning

Author: dave-lewis-alida

pandas/util/testing.py

@@ -2346,35 +2346,35 @@ def assert_produces_warning(expected_warning=Warning, filter_level="always",
 
     Parameters
     ----------
-    expected_warning : class Warning|False|None, default Warning
+    expected_warning : {Warning, False, None}, default Warning
         The type of Exception raised. ``exception.Warning`` is the base
         class for all warnings. To check that no warning is returned,
         specify ``False`` or ``None``.
     filter_level : str, default "always"
         Specifies whether warnings are ignored, displayed, or turned
         into errors.
         Valid values are:
-         "error" - turns matching warnings into exeptions
-         "ignore" - discard the warning
-         "always" - always emit a warning
-         "default" - print the warning the first time it is generated
-            from each location
-         "module" - print the warning the first time it is generated
-            from each module
-         "once" - print the warning the first time it is generated
+        * "error" - turns matching warnings into exeptions
+        * "ignore" - discard the warning
+        * "always" - always emit a warning
+        * "default" - print the warning the first time it is generated
+        from each location
+        * "module" - print the warning the first time it is generated
+        from each module
+        * "once" - print the warning the first time it is generated
     clear : str, default None
         If not ``None`` then remove any previously raised warnings from
         the ``__warningsregistry__`` to ensure that no warning messages are
         suppressed by this context manager. If ``None`` is specified,
         the ``__warningsregistry__`` keeps track of which warnings have been
          shown, and does not show them again.
-    check_stacklevel : bool, default true
+    check_stacklevel : bool, default True
         If True, displays the line that called the function containing
         the warning to show were the function is called. Otherwise, the
         line that implements the function is displayed.
 
     Examples
-    ----------
+    --------
     >>> import warnings
     >>> with assert_produces_warning():
     ...     warnings.warn(UserWarning())