DOC,STY,FIX: Fix syntax for names keyword argument.

DWesl · DWesl · commit 614f922510b9 · 2023-01-11T13:17:38.000-05:00
Also add a few reference links and types.
diff --git a/lib/matplotlib/testing/__init__.py b/lib/matplotlib/testing/__init__.py
@@ -56,14 +56,16 @@ def subprocess_run_for_testing(
         timeout: float = None,
         stdout=None,
         stderr=None,
-        check=False,
-        text=True,
-        capture_output=False
+        check: bool = False,
+        text: bool = True,
+        capture_output: bool = False
 ) -> "subprocess.Popen":
     """
     Create and run a subprocess.
 
-    Thin wrapper around subprocess.run, intended for testing.
+    Thin wrapper around `subprocess.run`, intended for testing.  Will
+    mark fork() failures on Cygwin as expected failures: not a
+    success, but not indicating a problem with the code either.
 
     Parameters
     ----------
@@ -73,9 +75,9 @@ def subprocess_run_for_testing(
     stdout, stderr
     check : bool
     text : bool
-        Also called `universal_newlines` in subprocess.  I chose this
-        name since the main effect is returning bytes (False) vs. str
-        (True), though it also tries to normalize newlines across
+        Also called ``universal_newlines`` in subprocess.  I chose this
+        name since the main effect is returning bytes (`False`) vs. str
+        (`True`), though it also tries to normalize newlines across
         platforms.
     capture_output : bool
         Set stdout and stderr to subprocess.PIPE
