Update docstrings for plot_directive.

anntzer · anntzer · commit ed07e056a82b · 2020-03-06T14:20:07.000+01:00
- Small edit to PlotDirective's docstring.
- In the module's docstring, avoid having tokens ("is", "for") that
  would get misthighlighted as Python keywords.  I did not move the
  entire block into a `.. code-block:: rst` because there are later
  cases where we show a python snippet under `.. plot::`, in which
  case having Python syntax highlighting is actually nicer.
diff --git a/lib/matplotlib/sphinxext/plot_directive.py b/lib/matplotlib/sphinxext/plot_directive.py
@@ -16,7 +16,7 @@
 
      .. plot:: path/to/plot.py
 
-        This is the caption for the plot
+        The plot's caption.
 
    Additionally, one may specify the name of a function to call (with
    no arguments) immediately after importing the module::
@@ -36,6 +36,7 @@
 3. Using **doctest** syntax::
 
      .. plot::
+
         A plotting example:
         >>> import matplotlib.pyplot as plt
         >>> plt.plot([1, 2, 3], [4, 5, 6])
@@ -221,10 +222,7 @@ def mark_plot_labels(app, document):
 
 
 class PlotDirective(Directive):
-    """Implementation of the ``.. plot::`` directive.
-
-    See the module docstring for details.
-    """
+    """The ``.. plot::`` directive, as documented in the module's docstring."""
 
     has_content = True
     required_arguments = 0
