Apply suggestions from code review

eytanadler · QuLogic · web-flow · commit 018f0fa19fb3 · 2024-12-19T09:30:30.000-05:00
Co-authored-by: Elliott Sales de Andrade &lt;quantum.analyst@gmail.com&gt;
diff --git a/doc/users/next_whats_new/streamplot_integration_control.rst b/doc/users/next_whats_new/streamplot_integration_control.rst
@@ -3,15 +3,15 @@ Streamplot integration control
 
 Two new options have been added to the `~.axes.Axes.streamplot` function that
 give the user better control of the streamline integration. The first is called
-``integration_max_step`` and multiplies the default max step computed by the
-integrator. The second is called ``integration_max_error`` and multiplies the
+``integration_max_step_scale`` and multiplies the default max step computed by the
+integrator. The second is called ``integration_max_error_scale`` and multiplies the
 default max error set by the integrator. Values for these parameters between
 zero and one reduce (tighten) the max step or error to improve streamline
 accuracy by performing more computation. Values greater than one increase
 (loosen) the max step or error to reduce computation time at the cost of lower
 streamline accuracy.
 
 The integrator defaults are both hand-tuned values and may not be applicable to
-all cases, so this allows the user to customize the behavior to specific use cases.
-Modifying only ``integration_max_step`` has proved effective, but it may be useful
+all cases, so this allows customizing the behavior to specific use cases.
+Modifying only ``integration_max_step_scale`` has proved effective, but it may be useful
 to control the error as well.
diff --git a/galleries/examples/images_contours_and_fields/plot_streamplot.py b/galleries/examples/images_contours_and_fields/plot_streamplot.py
@@ -84,7 +84,7 @@
 # ----------------------
 #
 # The streamlines are computed by integrating along the provided vector field
-# from the seed points, which are either generated automatically or manually
+# from the seed points, which are either automatically generated or manually
 # specified. The accuracy and smoothness of the streamlines can be adjusted using
 # the ``integration_max_step_scale`` and ``integration_max_error_scale`` optional
 # parameters. See the `~.axes.Axes.streamplot` function documentation for more
diff --git a/lib/matplotlib/streamplot.py b/lib/matplotlib/streamplot.py
@@ -121,13 +121,13 @@ def streamplot(axes, x, y, u, v, density=1, linewidth=None, color=None,
     if integration_max_step_scale <= 0.0:
         raise ValueError(
             "The value of integration_max_step_scale must be > 0, " +
-            f"got {integration_max_step_scale=}"
+            f"got {integration_max_step_scale}"
         )
 
     if integration_max_error_scale <= 0.0:
         raise ValueError(
             "The value of integration_max_error_scale must be > 0, " +
-            f"got {integration_max_error_scale=}"
+            f"got {integration_max_error_scale}"
         )
 
     if num_arrows < 0:
diff --git a/lib/matplotlib/tests/test_streamplot.py b/lib/matplotlib/tests/test_streamplot.py
@@ -214,13 +214,11 @@ def test_streamplot_integration_params():
     u = np.ones((2, 2))
     v = np.zeros((2, 2))
 
-    err_str = "The value of integration_max_step_scale must be > 0, " \
-              "got integration_max_step_scale=-0.5"
+    err_str = "The value of integration_max_step_scale must be > 0, got -0.5"
     with pytest.raises(ValueError, match=err_str):
         plt.streamplot(x, y, u, v, integration_max_step_scale=-0.5)
 
-    err_str = "The value of integration_max_error_scale must be > 0, " \
-              "got integration_max_error_scale=0.0"
+    err_str = "The value of integration_max_error_scale must be > 0, got 0.0"
     with pytest.raises(ValueError, match=err_str):
         plt.streamplot(x, y, u, v, integration_max_error_scale=0.0)
 

Original file line number	Diff line number	Diff line change
`@@ -84,7 +84,7 @@`
`84`	`84`	`# ----------------------`
`85`	`85`	`#`
`86`	`86`	`# The streamlines are computed by integrating along the provided vector field`
`87`		`-# from the seed points, which are either generated automatically or manually`
	`87`	`+# from the seed points, which are either automatically generated or manually`
`88`	`88`	`# specified. The accuracy and smoothness of the streamlines can be adjusted using`
`89`	`89`	# the ``integration_max_step_scale`` and ``integration_max_error_scale`` optional
`90`	`90`	# parameters. See the `~.axes.Axes.streamplot` function documentation for more
Original file line number	Diff line number	Diff line change
`@@ -121,13 +121,13 @@ def streamplot(axes, x, y, u, v, density=1, linewidth=None, color=None,`
`121`	`121`	`if integration_max_step_scale <= 0.0:`
`122`	`122`	`raise ValueError(`
`123`	`123`	`"The value of integration_max_step_scale must be > 0, " +`
`124`		`- f"got {integration_max_step_scale=}"`
	`124`	`+ f"got {integration_max_step_scale}"`
`125`	`125`	`)`
`126`	`126`
`127`	`127`	`if integration_max_error_scale <= 0.0:`
`128`	`128`	`raise ValueError(`
`129`	`129`	`"The value of integration_max_error_scale must be > 0, " +`
`130`		`- f"got {integration_max_error_scale=}"`
	`130`	`+ f"got {integration_max_error_scale}"`
`131`	`131`	`)`
`132`	`132`
`133`	`133`	`if num_arrows < 0:`