Rename output-base-name to image-basename

Author: asmeurer

lib/matplotlib/sphinxext/plot_directive.py

@@ -47,10 +47,10 @@
 
 The ``.. plot::`` directive supports the following options:
 
-``:output-base-name:`` : str
+``:image-basename:`` : str
     The base name (without the extension) of the outputted image files. The
     default is to use the same name as the input script, or the name of
-    the RST document if no script is provided. The output-base-name for each
+    the RST document if no script is provided. The image-basename for each
     plot directive must be unique.
 
 ``:format:`` : {'python', 'doctest'}
@@ -273,7 +273,7 @@ class PlotDirective(Directive):
         'scale': directives.nonnegative_int,
         'align': Image.align,
         'class': directives.class_option,
-        'output-base-name': directives.unchanged,
+        'image-basename': directives.unchanged,
         'include-source': _option_boolean,
         'show-source-link': _option_boolean,
         'format': _option_format,
@@ -642,16 +642,16 @@ def check_output_base_name(env, output_base):
 
     if '.' in output_base or '/' in output_base:
         raise PlotError(
-            f"The output-base-name '{output_base}' is invalid. "
+            f"The image-basename '{output_base}' is invalid. "
             f"It must not contain dots or slashes.")
 
     for d in env.mpl_custom_base_names:
         if output_base in env.mpl_custom_base_names[d]:
             if d == docname:
                 raise PlotError(
-                    f"The output-base-name "
+                    f"The image-basename "
                     f"{output_base}' is used multiple times.")
-            raise PlotError(f"The output-base-name "
+            raise PlotError(f"The image-basename "
                             f"'{output_base}' is used multiple times "
                             f"(it is also used in {env.doc2path(d)}).")
 
@@ -793,7 +793,7 @@ def run(arguments, content, options, state_machine, state, lineno):
 
     options.setdefault('include-source', config.plot_include_source)
     options.setdefault('show-source-link', config.plot_html_show_source_link)
-    options.setdefault('output-base-name', None)
+    options.setdefault('image-basename', None)
 
     if 'class' in options:
         # classes are parsed into a list of string, and output by simply
@@ -835,16 +835,16 @@ def run(arguments, content, options, state_machine, state, lineno):
             function_name = None
 
         code = Path(source_file_name).read_text(encoding='utf-8')
-        if options['output-base-name']:
-            output_base = options['output-base-name']
+        if options['image-basename']:
+            output_base = options['image-basename']
             check_output_base_name(env, output_base)
         else:
             output_base = os.path.basename(source_file_name)
     else:
         source_file_name = rst_file
         code = textwrap.dedent("\n".join(map(str, content)))
-        if options['output-base-name']:
-            output_base = options['output-base-name']
+        if options['image-basename']:
+            output_base = options['image-basename']
             check_output_base_name(env, output_base)
         else:
             base, ext = os.path.splitext(os.path.basename(source_file_name))

lib/matplotlib/tests/test_sphinxext.py

@@ -96,9 +96,9 @@ def plot_directive_file(num):
     assert filecmp.cmp(range_6, plot_file(17))
     # plot 22 is from the range6.py file again, but a different function
     assert filecmp.cmp(range_10, img_dir / 'range6_range10.png')
-    # plots 23 and 24 use a custom base name
-    assert filecmp.cmp(range_6, img_dir / 'custom-base-name-6.png')
-    assert filecmp.cmp(range_4, img_dir / 'custom-base-name-4.png')
+    # plots 23 and 24 use a custom basename
+    assert filecmp.cmp(range_6, img_dir / 'custom-basename-6.png')
+    assert filecmp.cmp(range_4, img_dir / 'custom-basename-4.png')
 
     # Modify the included plot
     contents = (tmp_path / 'included_plot_21.rst').read_bytes()

lib/matplotlib/tests/tinypages/some_plots.rst

@@ -175,12 +175,12 @@ Plot 22 uses a different specific function in a file with plot commands:
 
 .. plot:: range6.py range10
 
-Plots 23 and 24 use output-base-name.
+Plots 23 and 24 use image-basename.
 
 .. plot::
-   :output-base-name: custom-base-name-6
+   :image-basename: custom-basename-6
 
    plt.plot(range(6))
 
 .. plot:: range4.py
-   :output-base-name: custom-base-name-4
+   :image-basename: custom-basename-4