Change plot_dir_resolve_method to plot_path_resolution_method

183amir · 183amir · commit 7ceea9e77259 · 2019-03-03T16:12:17.000+01:00
diff --git a/doc/api/next_api_changes/2018-10-09-plot-directive.rst b/doc/api/next_api_changes/2018-10-09-plot-directive.rst
@@ -21,7 +21,7 @@ files in the host system.
 Since this will break documentations that were depending on the old behavior,
 there is a deprecation period and a new configuration option is introduced to
 get the old behavior. To get the old behavior specify
-``plot_dir_resolve_method='absolute'`` in ``conf.py`` and specify
-``plot_dir_resolve_method='relative'`` to get the new behavior. The old
-behavior might be removed in future. The users are advised to switch to the new
+``plot_path_resolution_method='old'`` in ``conf.py`` and specify
+``plot_path_resolution_method='relative'`` to get the new behavior. The old
+behavior will be removed in future. The users are advised to switch to the new
 behavior and fix the plot directives accordingly.
diff --git a/lib/matplotlib/sphinxext/plot_directive.py b/lib/matplotlib/sphinxext/plot_directive.py
@@ -100,26 +100,26 @@
             import numpy as np
             from matplotlib import pyplot as plt
 
-    plot_dir_resolve_method
+    plot_path_resolution_method
         The method to use for resolving file names that come after the
         ``plot::`` directive. Two options are available: ``relative`` and
-        ``absolute``. Defaults to ``absolute`` but the default value will
-        change to ``relative`` in future versions. The ``absolute`` method
-        is deprecated and might be removed in future. See the ``plot_basedir``
+        ``old``. Defaults to ``old`` but the default value will
+        change to ``relative`` in future versions. The ``old`` method
+        is deprecated and will be removed in future. See the ``plot_basedir``
         for explanation of methods.
 
     plot_basedir
         Base directory, to which ``plot::`` file names are relative.
         Defaults to the source directory.
 
-        If ``plot_dir_resolve_method`` is ``relative``, relative file names are
-        found relative to the directory of the file containing the directive.
-        Absolute file names (paths starting with ``/``) are found relative to
-        ``plot_basedir``.
+        If ``plot_path_resolution_method`` is ``relative``, relative file names
+        are found relative to the directory of the file containing the
+        directive. Absolute file names (paths starting with ``/``) are found
+        relative to ``plot_basedir``.
 
-        If ``plot_dir_resolve_method`` is ``absolute``, all files are found
-        relative to ``plot_basedir`` whether the paths start with ``/`` or not.
-        This method is deprecated and may be removed in future.
+        If ``plot_path_resolution_method`` is ``old``, relative paths are found
+        relative to ``plot_basedir`` and absolute paths point to files in the
+        host system. This method is deprecated and will be removed in future.
 
     plot_formats
         File formats to generate. List of tuples or strings::
@@ -687,7 +687,7 @@ def run(arguments, content, options, state_machine, state, lineno):
     if len(arguments):
 
         # if the new method is selected for resolving paths
-        if config.plot_dir_resolve_method.lower() == 'relative':
+        if config.plot_path_resolution_method.lower() == 'relative':
 
             if arguments[0].startswith('/'):
                 arguments[0] = arguments[0][1:]
@@ -703,7 +703,7 @@ def run(arguments, content, options, state_machine, state, lineno):
                 '3.2', message='You are using an old method '
                 'to resolve filenames of the ``.. ::plot`` directive. Please '
                 'switch to the new method by specifying '
-                '``plot_dir_resolve_method=\'relative\'`` in your conf.py '
+                '``plot_path_resolution_method=\'relative\'`` in your conf.py '
                 'and fix the filenames accordingly. Please see '
                 'matplotlib/doc/api/next_api_changes/2018-10-09-plot-directive.rst '
                 'for more information. The old method will be removed in '
